Get Started

API Reference

Class

PdfDocumentOcr

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfDocumentOcr.cs:20
Modifiers sealed

Caller-provider OCR enrichment for a loaded PDF document.

Inheritance

  • Object
  • PdfDocumentOcr

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 async Task<PdfSearchableOcrResult> MakeSearchableAsync(IPdfOcrProvider provider, PdfOcrMergeOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task<PdfSearchableOcrResult>

Recognizes selected pages and returns a PDF with geometry-aligned invisible text for accepted OCR words. Pages without accepted OCR content are left unchanged. Existing digital signatures may block the required full rewrite through the ordinary PDF mutation policy.

Parameters

provider OfficeIMO.Pdf.IPdfOcrProvider requiredposition: 0
options OfficeIMO.Pdf.PdfOcrMergeOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
public Task<PdfOcrMergeResult> ReadAsync(IPdfOcrProvider provider, PdfOcrMergeOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentOcr.cs:20
Returns: Task<PdfOcrMergeResult>

Renders the selected pages, invokes the caller-owned OCR provider, and merges accepted words into the same logical result contract returned by CancellationToken).

Parameters

provider OfficeIMO.Pdf.IPdfOcrProvider requiredposition: 0
options OfficeIMO.Pdf.PdfOcrMergeOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2