PdfSearchableOcrReview
OfficeIMO.Pdf.Ocr
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
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
Methods
public PdfSearchableOcrResult Apply(IEnumerable<PdfRecognizedWord> selectedWords, CancellationToken cancellationToken = default) #Creates 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 = default
Returns
PdfSearchableOcrResultpublic PdfSearchableOcrResult ApplyAll(CancellationToken cancellationToken = default) #Creates a searchable artifact using all words accepted by the canonical merge policy.
Parameters
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfSearchableOcrResultpublic PdfSearchableOcrResult ApplyCorrections(IReadOnlyDictionary<PdfRecognizedWord, string> selectedWords, CancellationToken cancellationToken = default) #Creates a searchable artifact from eligible words and their reviewed replacement text.
Parameters
- selectedWords System.Collections.Generic.IReadOnlyDictionary<OfficeIMO.Pdf.Ocr.PdfRecognizedWord, string>
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfSearchableOcrResultpublic string ExtractText(IEnumerable<PdfRecognizedWord> selectedWords, CancellationToken cancellationToken = default) #Returns 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 = default
Returns
stringpublic string ExtractText(IReadOnlyDictionary<PdfRecognizedWord, string> selectedWords, CancellationToken cancellationToken = default) #Returns reviewed replacement text in logical reading order without modifying the PDF.
Parameters
- selectedWords System.Collections.Generic.IReadOnlyDictionary<OfficeIMO.Pdf.Ocr.PdfRecognizedWord, string>
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic ValueTuple<double, double> GetPageSize(int pageNumber) #Returns the reviewed page size in the same visual points used by word geometry.
Parameters
- pageNumber int
Returns
ValueTuple<double, double>public PdfPageRenderResult RenderPage(int pageNumber, CancellationToken cancellationToken = default) #Renders one reviewed page from the captured source, using the recognition pixel budget.
Parameters
- pageNumber int
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfPageRenderResultInherited Methods
Properties
public PdfOcrMergeResult Ocr { get; } #Provider evidence and canonical merge decisions for the captured source.