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

OfficeDocumentOcrExecutionExtensions

Edit on GitHub
Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader.Ocr
Source revision 378fa9b4b0cb with working tree changes
Source OfficeDocumentOcrExecution.Budget.cs:7
Modifiers static

Runs optional OCR engines against bounded Reader candidates and merges recognized text.

Inheritance

  • Object
  • OfficeDocumentOcrExecutionExtensions

Methods

public static async Task<OfficeDocumentOcrExecutionResult> ApplyOcrAsync(OfficeDocumentReadResult document, IOcrEngine engine, OfficeDocumentOcrExecutionOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<OfficeDocumentOcrExecutionResult>

Executes an OCR engine over validated candidate assets, preserves deterministic result order, and enriches the document.

Parameters

document OfficeIMO.Reader.OfficeDocumentReadResult requiredposition: 0
engine OfficeIMO.Ocr.IOcrEngine requiredposition: 1
options OfficeIMO.Reader.OfficeDocumentOcrExecutionOptions? = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static async Task<OfficeDocumentOcrExecutionResult> ApplyOcrTreeAsync(OfficeDocumentReadResult document, IOcrEngine engine, OfficeDocumentOcrExecutionOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<OfficeDocumentOcrExecutionResult>

Executes OCR over a document and its nested results with one shared budget. Newly recognized nested text is projected into each parent for Markdown, chunk and AI consumers. Existing native content and rich nested results are preserved. Call after reading a container; Reader processors already visit individual documents and must not invoke this tree operation for every node.

Parameters

document OfficeIMO.Reader.OfficeDocumentReadResult requiredposition: 0
engine OfficeIMO.Ocr.IOcrEngine requiredposition: 1
options OfficeIMO.Reader.OfficeDocumentOcrExecutionOptions? = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3