API Reference
Class
OfficeDocumentReadResultExtensions
Location and search helpers for the normalized document read result.
Inheritance
- Object
- OfficeDocumentReadResultExtensions
Methods
public static IReadOnlyList<OfficeDocumentPageMarkdown> GetPageMarkdown(OfficeDocumentReadResult document, OfficeDocumentPageMarkdownOptions options = null) #Returns:
IReadOnlyList<OfficeDocumentPageMarkdown>Projects every page-like container into a separate Markdown value suitable for citations and RAG.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- options OfficeIMO.Reader.OfficeDocumentPageMarkdownOptions = null
public static OfficeDocumentPageProvenance GetPageProvenance(OfficeDocumentReadResult document) #Returns:
OfficeDocumentPageProvenanceReturns the page provenance advertised by the producing adapter.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static Int32 GetTotalPageCount(OfficeDocumentReadResult document) #Returns:
Int32Returns the best available total physical page count for this read result.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
Locate 2 overloads
public static IReadOnlyList<OfficeDocumentPageLocation> Locate(OfficeDocumentReadResult document, OfficeDocumentBlock block) #Returns:
IReadOnlyList<OfficeDocumentPageLocation>Locates a normalized block in every page-like container that references it.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- block OfficeIMO.Reader.OfficeDocumentBlock
public static IReadOnlyList<OfficeDocumentPageLocation> Locate(OfficeDocumentReadResult document, String blockId) #Returns:
IReadOnlyList<OfficeDocumentPageLocation>Locates a normalized block by its stable identifier.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- blockId System.String
public static OfficeDocumentSearchResult Search(OfficeDocumentReadResult document, String query, OfficeDocumentSearchOptions options = null) #Returns:
OfficeDocumentSearchResultSearches normalized document blocks and attaches page-like locations to every occurrence.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- query System.String
- options OfficeIMO.Reader.OfficeDocumentSearchOptions = null
public static String ToPageMarkedMarkdown(OfficeDocumentReadResult document) #Returns:
StringProjects all page-like containers into one Markdown string separated by portable page markers.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult