API Reference
PdfDocumentImageEditor
Finds and edits image placements on existing PDF pages.
Inheritance
- Object
- PdfDocumentImageEditor
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property PdfDocument.Images
Methods
public PdfImageEditResult Add(PdfPageRegion target, Byte[] imageBytes, PdfImageEditOptions options = null, PdfLoadOptions readOptions = null) #PdfImageEditResultAdds an image fitted to a page region.
Parameters
- target OfficeIMO.Pdf.PdfPageRegion
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageEditOptions = null
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfExtractedImage> Extract(PdfLoadOptions readOptions = null) #IReadOnlyList<PdfExtractedImage>Extracts every unique embedded image XObject in page order.
Parameters
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfExtractedImage> Extract(PdfPageSelection selection, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfExtractedImage>Extracts embedded images referenced by a caller-ordered page selection.
Parameters
- selection OfficeIMO.Pdf.PdfPageSelection
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfExtractedImage> Extract(String pageRanges, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfExtractedImage>Extracts embedded images referenced by parsed one-based page ranges.
Parameters
- pageRanges System.String
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfExtractedImage> Extract(PdfPageSelector selector, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfExtractedImage>Extracts embedded images referenced by a document-relative page selector.
Parameters
- selector OfficeIMO.Pdf.PdfPageSelector
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<IReadOnlyList<PdfExtractedImage>> ExtractResult(PdfLoadOptions readOptions = null) #PdfOperationResult<IReadOnlyList<PdfExtractedImage>>Attempts to extract images, returning preflight diagnostics when blocked or failed.
Parameters
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfImagePlacement> Find(PdfPageRegion region, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfImagePlacement>Returns image placements whose page-space bounds intersect a region.
Parameters
- region OfficeIMO.Pdf.PdfPageRegion
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public PdfImageEditResult Move(PdfImagePlacement placement, Double deltaX, Double deltaY, PdfImageEditOptions options = null, PdfLoadOptions readOptions = null) #PdfImageEditResultMoves one exact image placement by a PDF user-space offset. The source payload, portable size, and rotation are preserved; the selected Layer controls its new page-content layer.
Parameters
- placement OfficeIMO.Pdf.PdfImagePlacement
- deltaX System.Double
- deltaY System.Double
- options OfficeIMO.Pdf.PdfImageEditOptions = null
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfImagePlacement> Placements(PdfLoadOptions readOptions = null) #IReadOnlyList<PdfImagePlacement>Returns every image placement invocation in page paint order.
Parameters
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfImagePlacement> Placements(PdfPageSelection selection, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfImagePlacement>Returns image placements referenced by a caller-ordered page selection.
Parameters
- selection OfficeIMO.Pdf.PdfPageSelection
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfImagePlacement> Placements(String pageRanges, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfImagePlacement>Returns image placements referenced by parsed one-based page ranges.
Parameters
- pageRanges System.String
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public IReadOnlyList<PdfImagePlacement> Placements(PdfPageSelector selector, PdfLoadOptions readOptions = null) #IReadOnlyList<PdfImagePlacement>Returns image placements referenced by a document-relative page selector.
Parameters
- selector OfficeIMO.Pdf.PdfPageSelector
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<IReadOnlyList<PdfImagePlacement>> PlacementsResult(PdfLoadOptions readOptions = null) #PdfOperationResult<IReadOnlyList<PdfImagePlacement>>Attempts to inspect image placements, returning preflight diagnostics when blocked or failed.
Parameters
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public PdfImageEditResult Remove(PdfImagePlacement placement, PdfLoadOptions readOptions = null) #PdfImageEditResultRemoves one exact image placement without removing text, paths, annotations, or other overlapping images.
Parameters
- placement OfficeIMO.Pdf.PdfImagePlacement
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null
public PdfImageEditResult Replace(PdfImagePlacement placement, Byte[] imageBytes, PdfImageEditOptions options = null, PdfLoadOptions readOptions = null) #PdfImageEditResultReplaces one exact image placement while preserving portable position, size, and rotation. The selected Layer controls its new relation to existing page content.
Parameters
- placement OfficeIMO.Pdf.PdfImagePlacement
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageEditOptions = null
- readOptions OfficeIMO.Pdf.PdfLoadOptions = null