Get Started

API Reference

Class

PdfDocumentTextEditor

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

Searches and edits text on existing PDF pages.

Inheritance

  • Object
  • PdfDocumentTextEditor

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 PdfTextEditResult Add(PdfPageRegion region, String text, PdfTextEditOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:19
Returns: PdfTextEditResult

Adds text at the top-left of a page region without removing existing content.

Parameters

region OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
text System.String requiredposition: 1
options OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 3
public IReadOnlyList<PdfTextMatch> Find(String text, PdfTextSearchOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:15
Returns: IReadOnlyList<PdfTextMatch>

Finds visible, unclipped text occurrences and optionally OCR-style rendering-mode-3 text.

Parameters

text System.String requiredposition: 0
options OfficeIMO.Pdf.PdfTextSearchOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 2
public PdfRegionText Inspect(PdfPageRegion region, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:11
Returns: PdfRegionText

Returns text and dominant style inside a page region.

Parameters

region OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 1
Move 2 overloads
public PdfTextEditResult Move(PdfPageRegion region, Double deltaX, Double deltaY, PdfTextEditOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:37
Returns: PdfTextEditResult

Moves text objects intersecting a region by a PDF user-space offset.

Parameters

region OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
deltaX System.Double requiredposition: 1
deltaY System.Double requiredposition: 2
options OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 3
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 4
public PdfTextEditResult Move(PdfTextMatch match, Double deltaX, Double deltaY, PdfTextEditOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:43
Returns: PdfTextEditResult

Moves one located text occurrence while leaving unmatched source-span text at its original position.

Parameters

match OfficeIMO.Pdf.PdfTextMatch requiredposition: 0
deltaX System.Double requiredposition: 1
deltaY System.Double requiredposition: 2
options OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 3
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 4
Replace 2 overloads
public PdfTextEditResult Replace(PdfPageRegion region, String text, PdfTextEditOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:25
Returns: PdfTextEditResult

Removes text objects intersecting a region and adds replacement text in the detected style.

Parameters

region OfficeIMO.Pdf.PdfPageRegion requiredposition: 0
text System.String requiredposition: 1
options OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 3
public PdfTextEditResult Replace(PdfTextMatch match, String text, PdfTextEditOptions options = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:31
Returns: PdfTextEditResult

Replaces one located text occurrence while preserving unmatched source-span text.

Parameters

match OfficeIMO.Pdf.PdfTextMatch requiredposition: 0
text System.String requiredposition: 1
options OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 3
public PdfTextEditResult ReplaceAll(String text, String replacement, PdfTextSearchOptions searchOptions = null, PdfTextEditOptions editOptions = null, PdfLoadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentTextEditor.cs:49
Returns: PdfTextEditResult

Replaces every located occurrence while preserving exact unmatched source-span text and independent visual runs.

Parameters

text System.String requiredposition: 0
replacement System.String requiredposition: 1
searchOptions OfficeIMO.Pdf.PdfTextSearchOptions = null optionalposition: 2
editOptions OfficeIMO.Pdf.PdfTextEditOptions = null optionalposition: 3
readOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 4