Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 579 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/

API Reference

Class

PdfOcrExtensions

Edit on GitHub
Namespace OfficeIMO.Pdf.Ocr
Assembly OfficeIMO.Pdf.Ocr
Source revision dce3df7a1b5d with working tree changes
Source PdfOcrExtensions.cs:14
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 = default) #
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 = default optionalposition: 3
public static Task<PdfPageOrientationReview> PrepareOrientationReviewAsync(PdfDocument document, IOcrEngine engine, PdfOcrMergeOptions? options = null, CancellationToken cancellationToken = default) #
PdfOcr.OrientationReview.cs:13
Returns: Task<PdfPageOrientationReview>

Detects whole-page corrective quarter-turns on a private snapshot without changing the PDF.

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 = default optionalposition: 3
public static async Task<PdfSearchableOcrReview> PrepareSearchableOcrAsync(PdfDocument document, IOcrEngine engine, PdfOcrMergeOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSearchableOcrReview>

Recognizes a private source snapshot and returns review evidence without modifying or publishing a PDF.

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 = default optionalposition: 3
public static Task<PdfScanPreview> PreviewScanAsync(PdfDocument document, Int32 pageNumber, PdfOcrMergeOptions? options = null, CancellationToken cancellationToken = default) #
PdfOcrExtensions.cs:14
Returns: Task<PdfScanPreview>

Previews one page using the same region, perspective, and scan preparation as OCR, without invoking a provider. Provider orientation detection is not performed. Source bytes remain unchanged.

Parameters

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

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

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 = default optionalposition: 3