API Reference
PdfSearchableOcrReview
Recognition evidence and a private source snapshot for reviewing a searchable layer before mutation.
Inheritance
- Object
- PdfSearchableOcrReview
Remarks
Selections may exclude eligible words. Rejected words cannot bypass confidence or native-text overlap policy; change recognition options and prepare another review when those policies need to change.
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 PdfSearchableOcrResult Apply(IEnumerable<PdfRecognizedWord> selectedWords, CancellationToken cancellationToken = null) #PdfSearchableOcrResultCreates a searchable artifact using only the selected eligible word instances from this review.
Parameters
- selectedWords System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.Ocr.PdfRecognizedWord}
- cancellationToken System.Threading.CancellationToken = null
public PdfSearchableOcrResult ApplyAll(CancellationToken cancellationToken = null) #PdfSearchableOcrResultCreates a searchable artifact using all words accepted by the canonical merge policy.
Parameters
- cancellationToken System.Threading.CancellationToken = null
public PdfSearchableOcrResult ApplyCorrections(IReadOnlyDictionary<PdfRecognizedWord, String> selectedWords, CancellationToken cancellationToken = null) #PdfSearchableOcrResultCreates a searchable artifact from eligible words and their reviewed replacement text.
Parameters
- selectedWords System.Collections.Generic.IReadOnlyDictionary{OfficeIMO.Pdf.Ocr.PdfRecognizedWord,System.String}
- cancellationToken System.Threading.CancellationToken = null
public String ExtractText(IEnumerable<PdfRecognizedWord> selectedWords, CancellationToken cancellationToken = null) #StringReturns selected eligible words in logical reading order without creating or modifying a PDF.
Parameters
- selectedWords System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.Ocr.PdfRecognizedWord}
- cancellationToken System.Threading.CancellationToken = null
public ValueTuple<Double, Double> GetPageSize(Int32 pageNumber) #ValueTuple<Double, Double>Returns the reviewed page size in the same visual points used by word geometry.
Parameters
- pageNumber System.Int32
public PdfPageRenderResult RenderPage(Int32 pageNumber, CancellationToken cancellationToken = null) #PdfPageRenderResultRenders one reviewed page from the captured source, using the recognition pixel budget.
Parameters
- pageNumber System.Int32
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public PdfOcrMergeResult Ocr { get; } #Provider evidence and canonical merge decisions for the captured source.