Get Started

API Reference

Class

PdfDocumentImageEditor

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:11
Modifiers sealed

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

Methods

public PdfImageEditResult Add(PdfPageRegion target, Byte[] imageBytes, PdfImageEditOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:19
Returns: PdfImageEditResult

Adds an image fitted to a page region.

Parameters

target OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
imageBytes System.Byte[] requiredposition: 1
options OfficeIMO.Pdf.PdfImageEditOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public IReadOnlyList<PdfImagePlacement> Find(PdfPageRegion region, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:15
Returns: IReadOnlyList<PdfImagePlacement>

Returns image placements whose page-space bounds intersect a region.

Parameters

region OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfImageEditResult Move(PdfImagePlacement placement, Double deltaX, Double deltaY, PdfImageEditOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:37
Returns: PdfImageEditResult

Moves 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 requiredposition: 0
deltaX System.Double requiredposition: 1
deltaY System.Double requiredposition: 2
options OfficeIMO.Pdf.PdfImageEditOptions = null optionalposition: 3
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 4
public IReadOnlyList<PdfImagePlacement> Placements(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:11
Returns: IReadOnlyList<PdfImagePlacement>

Returns every image placement invocation in page paint order.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfImageEditResult Remove(PdfImagePlacement placement, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:23
Returns: PdfImageEditResult

Removes one exact image placement without removing text, paths, annotations, or other overlapping images.

Parameters

placement OfficeIMO.Pdf.PdfImagePlacement requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfImageEditResult Replace(PdfImagePlacement placement, Byte[] imageBytes, PdfImageEditOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentImageEditor.cs:30
Returns: PdfImageEditResult

Replaces 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 requiredposition: 0
imageBytes System.Byte[] requiredposition: 1
options OfficeIMO.Pdf.PdfImageEditOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3