Get Started

API Reference

Class

PdfOcrExtensions

Edit on GitHub
Namespace OfficeIMO.Pdf.Ocr
Assembly OfficeIMO.Pdf.Ocr
Source OfficeIMO.Pdf.Ocr/PdfOcrExtensions.cs:19
Modifiers static

Optional OCR operations for loaded PDF documents.

Inheritance

  • Object
  • PdfOcrExtensions

Methods

public static async Task<PdfSearchableOcrResult> MakeSearchableAsync(PdfDocument document, IOcrEngine engine, PdfOcrMergeOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task<PdfSearchableOcrResult>

Returns a PDF with geometry-aligned invisible text for accepted OCR spans. Pages without accepted OCR content remain unchanged. Existing digital signatures may block the required full rewrite.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
engine OfficeIMO.Ocr.IOcrEngine requiredposition: 1
options OfficeIMO.Pdf.Ocr.PdfOcrMergeOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Task<PdfOcrMergeResult> ReadWithOcrAsync(PdfDocument document, IOcrEngine engine, PdfOcrMergeOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf.Ocr/PdfOcrExtensions.cs:19
Returns: Task<PdfOcrMergeResult>

Renders selected pages, invokes an engine-neutral OCR provider, and merges accepted spans into the same logical result contract returned by CancellationToken).

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
engine OfficeIMO.Ocr.IOcrEngine requiredposition: 1
options OfficeIMO.Pdf.Ocr.PdfOcrMergeOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3