API Reference
OfficeDocumentReadResultExtensions
Location and search helpers for the normalized document read result.
Inheritance
- Object
- OfficeDocumentReadResultExtensions
Methods
public static IEnumerable<OfficeDocumentBlock> EnumerateBlocks(OfficeDocumentReadResult document) #IEnumerable<OfficeDocumentBlock>Enumerates document-level and page-level blocks in canonical source order, retaining each stable ID or anchor once. Blocks without either identity are deduplicated only by object reference, preserving unlabelled repeated text. Missing locations inherit their page context by reference or stable identity without changing the source. Results may refer to source objects or location projections; they are not immutable snapshots.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IEnumerable<OfficeDocumentContentItem> EnumerateContent(OfficeDocumentReadResult document) #IEnumerable<OfficeDocumentContentItem>Enumerates blocks and tables together in canonical source order. Chunks supply text only when no blocks contain text. Tables inherit a matching source block's position through their stable anchor. Table rows remain part of their table. Unpositioned content retains its encounter order after positioned content in the same container. Results reference source payloads or location projections and are not immutable snapshots.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IEnumerable<ReaderTable> EnumerateTables(OfficeDocumentReadResult document) #IEnumerable<ReaderTable>Enumerates tables from document, page and chunk projections using the Reader's canonical duplicate handling. Page-only tables inherit missing location information from their page. Results may refer to source model objects.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IReadOnlyList<OfficeDocumentPageMarkdown> GetPageMarkdown(OfficeDocumentReadResult document, OfficeDocumentPageMarkdownOptions? options = null) #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) #OfficeDocumentPageProvenanceReturns the page provenance advertised by the producing adapter.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static Int32 GetTotalPageCount(OfficeDocumentReadResult document) #Int32Returns the best available total physical page count for this read result.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IReadOnlyList<OfficeDocumentPageLocation> Locate(OfficeDocumentReadResult document, OfficeDocumentBlock block) #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) #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) #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) #StringProjects all page-like containers into one Markdown string separated by portable page markers.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?