Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 701 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

PdfDocumentTextEditor

OfficeIMO.Pdf

Edit on GitHub
Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
ac7e6e1bad8a with working tree changes
Source
PdfDocumentTextEditor.cs:14
Modifiers
sealed

Searches and edits text on existing PDF pages.

Inheritance

  • object
  • PdfDocumentTextEditor

Remarks

Replacement retains an embedded source font when its subset covers the text. Otherwise, text supported by the standard PDF encoding uses a standard font and the result reports substitution. Text outside both encodings is rejected. Native page coordinates use default user-space units: one unit is /UserUnit physical points (1/72 inch each), defaulting to 1. Local text/font and matrix values retain their native coordinate spaces. Explicit visual projections use their documented coordinates.

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Methods

public PdfTextEditResult Add(PdfPageRegion region, string text, PdfTextEditOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:27

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

Parameters

region OfficeIMO.Pdf.PdfPageRegion required
text string required
options OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
public IReadOnlyList<PdfTextMatch> Find(string text, PdfTextSearchOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:18

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

Parameters

text string required
options OfficeIMO.Pdf.PdfTextSearchOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

IReadOnlyList<PdfTextMatch>
public PdfRegionText Inspect(PdfPageRegion region, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:14

Returns text and dominant style inside a page region.

Parameters

region OfficeIMO.Pdf.PdfPageRegion required
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfRegionText
Move 2 overloads
public PdfTextEditResult Move(PdfPageRegion region, double deltaX, double deltaY, PdfTextEditOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:45

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

Parameters

region OfficeIMO.Pdf.PdfPageRegion required
deltaX double required
deltaY double required
options OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
public PdfTextEditResult Move(PdfTextMatch match, double deltaX, double deltaY, PdfTextEditOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:51

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

Parameters

match OfficeIMO.Pdf.PdfTextMatch required
deltaX double required
deltaY double required
options OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
Replace 2 overloads
public PdfTextEditResult Replace(PdfPageRegion region, string text, PdfTextEditOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:33

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

Parameters

region OfficeIMO.Pdf.PdfPageRegion required
text string required
options OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
public PdfTextEditResult Replace(PdfTextMatch match, string text, PdfTextEditOptions? options = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:39

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

Parameters

match OfficeIMO.Pdf.PdfTextMatch required
text string required
options OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
public PdfTextEditResult ReplaceAll(string text, string replacement, PdfTextSearchOptions? searchOptions = null, PdfTextEditOptions? editOptions = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:57

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

Parameters

text string required
replacement string required
searchOptions OfficeIMO.Pdf.PdfTextSearchOptions? = null optional
editOptions OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult
public PdfTextEditResult ReplaceSelected(string text, string replacement, IReadOnlyCollection<int> occurrenceIndexes, PdfTextSearchOptions? searchOptions = null, PdfTextEditOptions? editOptions = null, PdfLoadOptions? readOptions = null) #
PdfDocumentTextEditor.cs:65

Replaces selected zero-based occurrences from PdfDocumentTextEditor.Find using the same search options and current document revision.

Parameters

text string required
replacement string required
occurrenceIndexes System.Collections.Generic.IReadOnlyCollection<int> required
searchOptions OfficeIMO.Pdf.PdfTextSearchOptions? = null optional
editOptions OfficeIMO.Pdf.PdfTextEditOptions? = null optional
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfTextEditResult