Get Started

API Reference

Class

DocumentReaderEngine

Namespace OfficeIMO.Reader

Unified, read-only document extraction facade intended for AI ingestion.

Inheritance

  • Object
  • DocumentReaderEngine

Remarks

This facade is intentionally dependency-free and deterministic. It normalizes extraction into ReaderChunk instances with stable IDs and location metadata. Read operations are thread-safe. Use OfficeDocumentReaderBuilder when modular handlers or a processing pipeline are required.

Methods

ChunkDocument(OfficeIMO.Reader.OfficeDocumentReadResult document, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions options, System.Threading.CancellationToken cancellationToken) #

Token-chunks an already-read rich document and builds its hierarchy.

Parameters

document OfficeIMO.Reader.OfficeDocumentReadResult required
options OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
CreateDocumentResult(System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} chunks, OfficeIMO.Reader.ReaderInputKind fallbackKind, OfficeIMO.Reader.OfficeDocumentSource source, System.Collections.Generic.IEnumerable{System.String} capabilities, System.Collections.Generic.IReadOnlyList{OfficeIMO.Reader.OfficeDocumentAsset} assets) #

Creates the shared v5 document envelope from adapter-produced chunks and optional source data.

Parameters

chunks System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} required
fallbackKind OfficeIMO.Reader.ReaderInputKind required
source OfficeIMO.Reader.OfficeDocumentSource required
capabilities System.Collections.Generic.IEnumerable{System.String} required
assets System.Collections.Generic.IReadOnlyList{OfficeIMO.Reader.OfficeDocumentAsset} required
Detect 3 overloads
Detect(System.String path, OfficeIMO.Reader.ReaderDetectionOptions options) #

Detects a file kind from extension and bounded content evidence.

Parameters

path System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
Detect(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderDetectionOptions options) #

Detects a stream kind from source-name and bounded content evidence. Seekable streams are restored to their original position. Non-seekable streams are advanced by at most MaxProbeBytes.

Parameters

stream System.IO.Stream required
sourceName System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
Detect(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderDetectionOptions options) #

Detects a byte payload kind from source-name and bounded content evidence.

Parameters

bytes System.Byte[] required
sourceName System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
DetectAsync 3 overloads
DetectAsync(System.String path, OfficeIMO.Reader.ReaderDetectionOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously detects a file kind from extension and bounded content evidence.

Parameters

path System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
cancellationToken System.Threading.CancellationToken required
DetectAsync(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderDetectionOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously detects a stream kind from source-name and bounded content evidence. Seekable streams are restored to their original position.

Parameters

stream System.IO.Stream required
sourceName System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
cancellationToken System.Threading.CancellationToken required
DetectAsync(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderDetectionOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously detects a byte payload kind from source-name and bounded content evidence.

Parameters

bytes System.Byte[] required
sourceName System.String required
options OfficeIMO.Reader.ReaderDetectionOptions required
cancellationToken System.Threading.CancellationToken required
DetectKind(System.String path) #

Detects the input kind based on file extension.

Parameters

path System.String required
Source file path.
ExportTables(System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderTable} tables, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Builds deterministic CSV, Markdown, and JSON payloads for discovered reader tables.

Parameters

tables System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderTable} required
Reader tables to export.
indentedJson System.Boolean required
When true, writes indented table JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ExportVisuals(System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderVisual} visuals, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Builds deterministic payload and JSON sidecars for discovered reader visuals.

Parameters

visuals System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderVisual} required
Reader visuals to export.
indentedJson System.Boolean required
When true, writes indented visual JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ExtractAssets(OfficeIMO.Reader.OfficeDocumentReadResult result, System.Func{OfficeIMO.Reader.OfficeDocumentAsset,System.Boolean} predicate, System.Threading.CancellationToken cancellationToken) #

Returns assets already attached to a shared read result, optionally filtered by caller-owned policy.

Parameters

result OfficeIMO.Reader.OfficeDocumentReadResult required
Read result to inspect.
predicate System.Func{OfficeIMO.Reader.OfficeDocumentAsset,System.Boolean} required
Optional predicate used to select assets.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ExtractMarkdownTables(System.String markdown, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Extracts structured tables from Markdown text using the same parser path as Markdown reader chunks.

Parameters

markdown System.String required
Markdown text to inspect.
options OfficeIMO.Reader.ReaderOptions required
Reader options. MaxTableRows is honored.
cancellationToken System.Threading.CancellationToken required
Cancellation token.

Returns

Tables discovered in source order.

ExtractStructured(OfficeIMO.Reader.OfficeDocumentReadResult document, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions options, System.Threading.CancellationToken cancellationToken) #

Extracts a bounded structured view from an already-read document.

Parameters

document OfficeIMO.Reader.OfficeDocumentReadResult required
options OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ExtractTables(System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} chunks, System.Threading.CancellationToken cancellationToken) #

Extracts table metadata already attached to reader chunks.

Parameters

chunks System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} required
Reader chunks to inspect.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ExtractVisuals(System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} chunks, System.Threading.CancellationToken cancellationToken) #

Extracts visual payload metadata already attached to reader chunks.

Parameters

chunks System.Collections.Generic.IEnumerable{OfficeIMO.Reader.ReaderChunk} required
Reader chunks to inspect.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
GetCapabilities() #

Lists the capabilities supported by the built-in static reader.

GetCapabilityManifest() #

Builds a machine-readable capability manifest for the built-in static reader.

GetCapabilityManifestJson(System.Boolean indented) #

Builds a JSON capability manifest payload for the built-in static reader.

Parameters

indented System.Boolean required
Read 3 overloads
Read(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and emits normalized extraction chunks.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
Read(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from a stream and emits normalized extraction chunks.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection (via extension) and citations/IDs. For example: "Policy.docx" or "Workbook.xlsx".
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
Read(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and emits normalized extraction chunks.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection (via extension) and citations/IDs. For example: "Policy.docx" or "Workbook.xlsx".
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadAssets 3 overloads
ReadAssets(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns discovered assets in source order.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadAssets(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns discovered assets in source order.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadAssets(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns discovered assets in source order.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadAsync 3 overloads
ReadAsync(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a file into normalized chunks. Native async handlers are awaited directly; synchronous format parsing runs after the input has been read asynchronously.

Parameters

path System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadAsync(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a stream into normalized chunks. The caller retains ownership of the stream.

Parameters

stream System.IO.Stream required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadAsync(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads bytes into normalized chunks.

Parameters

bytes System.Byte[] required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadDocument 3 overloads
ReadDocument(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns the shared OfficeIMO read result envelope.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadDocument(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns the shared OfficeIMO read result envelope.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadDocument(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns the shared OfficeIMO read result envelope.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadDocumentAsync 3 overloads
ReadDocumentAsync(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a file into the shared rich document envelope.

Parameters

path System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadDocumentAsync(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a stream into the shared rich document envelope. The caller retains ownership of the stream.

Parameters

stream System.IO.Stream required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadDocumentAsync(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads bytes into the shared rich document envelope.

Parameters

bytes System.Byte[] required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
cancellationToken System.Threading.CancellationToken required
ReadDocumentJson 3 overloads
ReadDocumentJson(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Boolean indented, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns the shared OfficeIMO read result JSON envelope.

Parameters

path System.String required
options OfficeIMO.Reader.ReaderOptions required
indented System.Boolean required
cancellationToken System.Threading.CancellationToken required
ReadDocumentJson(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indented, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns the shared OfficeIMO read result JSON envelope.

Parameters

stream System.IO.Stream required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
indented System.Boolean required
cancellationToken System.Threading.CancellationToken required
ReadDocumentJson(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indented, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns the shared OfficeIMO read result JSON envelope.

Parameters

bytes System.Byte[] required
sourceName System.String required
options OfficeIMO.Reader.ReaderOptions required
indented System.Boolean required
cancellationToken System.Threading.CancellationToken required
ReadDocumentsAsync(System.Collections.Generic.IEnumerable{System.String} paths, OfficeIMO.Reader.ReaderOptions options, OfficeIMO.Reader.ReaderBatchOptions batchOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a bounded set of files with deterministic result ordering.

Parameters

paths System.Collections.Generic.IEnumerable{System.String} required
options OfficeIMO.Reader.ReaderOptions required
batchOptions OfficeIMO.Reader.ReaderBatchOptions required
cancellationToken System.Threading.CancellationToken required
ReadFolder 2 overloads
ReadFolder(System.String folderPath, OfficeIMO.Reader.ReaderFolderOptions folderOptions, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Enumerates a folder and ingests all supported files (best-effort), emitting warning chunks for skipped files.

Parameters

folderPath System.String required
Folder path.
folderOptions OfficeIMO.Reader.ReaderFolderOptions required
Folder enumeration options.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadFolder(System.String folderPath, OfficeIMO.Reader.ReaderFolderOptions folderOptions, OfficeIMO.Reader.ReaderOptions options, System.Action{OfficeIMO.Reader.ReaderProgress} onProgress, System.Threading.CancellationToken cancellationToken) #

Enumerates a folder and ingests all supported files (best-effort), emitting warning chunks for skipped files.

Parameters

folderPath System.String required
Folder path.
folderOptions OfficeIMO.Reader.ReaderFolderOptions required
Folder enumeration options.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
onProgress System.Action{OfficeIMO.Reader.ReaderProgress} required
Optional progress callback for file-level lifecycle and aggregate counts.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadFolderDetailed(System.String folderPath, OfficeIMO.Reader.ReaderFolderOptions folderOptions, OfficeIMO.Reader.ReaderOptions options, System.Boolean includeChunks, System.Action{OfficeIMO.Reader.ReaderProgress} onProgress, System.Threading.CancellationToken cancellationToken) #

Reads a folder and returns ingestion-ready summary/counts with optional chunk materialization.

Parameters

folderPath System.String required
Folder path.
folderOptions OfficeIMO.Reader.ReaderFolderOptions required
Folder enumeration options.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
includeChunks System.Boolean required
When true, materializes chunks in the result object.
onProgress System.Action{OfficeIMO.Reader.ReaderProgress} required
Optional progress callback.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadFolderDocuments(System.String folderPath, OfficeIMO.Reader.ReaderFolderOptions folderOptions, OfficeIMO.Reader.ReaderOptions options, System.Action{OfficeIMO.Reader.ReaderProgress} onProgress, System.Threading.CancellationToken cancellationToken) #

Enumerates a folder and emits one source-level payload per file, ready for direct DB upserts.

Parameters

folderPath System.String required
Folder path.
folderOptions OfficeIMO.Reader.ReaderFolderOptions required
Folder enumeration options.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
onProgress System.Action{OfficeIMO.Reader.ReaderProgress} required
Optional progress callback for file-level lifecycle and aggregate counts.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadHierarchical 3 overloads
ReadHierarchical(System.String path, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Reads a file and returns bounded token-aware hierarchical chunks.

Parameters

path System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadHierarchical(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Reads a stream and returns bounded token-aware hierarchical chunks.

Parameters

stream System.IO.Stream required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadHierarchical(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Reads bytes and returns bounded token-aware hierarchical chunks.

Parameters

bytes System.Byte[] required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadHierarchicalAsync 3 overloads
ReadHierarchicalAsync(System.String path, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a file and returns bounded token-aware hierarchical chunks.

Parameters

path System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadHierarchicalAsync(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a stream and returns bounded token-aware hierarchical chunks.

Parameters

stream System.IO.Stream required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadHierarchicalAsync(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.ReaderHierarchicalChunkingOptions chunkingOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads bytes and returns bounded token-aware hierarchical chunks.

Parameters

bytes System.Byte[] required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
chunkingOptions OfficeIMO.Reader.ReaderHierarchicalChunkingOptions required
cancellationToken System.Threading.CancellationToken required
ReadPathDocumentsDetailed(System.String path, OfficeIMO.Reader.ReaderFolderOptions folderOptions, OfficeIMO.Reader.ReaderOptions options, System.Boolean includeDocumentChunks, System.Nullable{System.Int32} maxReturnedChunks, System.Action{OfficeIMO.Reader.ReaderProgress} onProgress, System.Threading.CancellationToken cancellationToken) #

Reads a supported file or folder path and returns source-level document payloads with optional chunk shaping.

Parameters

path System.String required
Source file or folder path.
folderOptions OfficeIMO.Reader.ReaderFolderOptions required
Folder enumeration options when path is a directory.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
includeDocumentChunks System.Boolean required
When true, includes chunk arrays in returned source documents.
maxReturnedChunks System.Nullable{System.Int32} required
Optional cap across all returned document chunks.
onProgress System.Action{OfficeIMO.Reader.ReaderProgress} required
Optional progress callback for folder reads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadStructured 3 overloads
ReadStructured(System.String path, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Reads a file and extracts a bounded structured view.

Parameters

path System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadStructured(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Reads a stream and extracts a bounded structured view.

Parameters

stream System.IO.Stream required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadStructured(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Reads bytes and extracts a bounded structured view.

Parameters

bytes System.Byte[] required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadStructuredAsync 3 overloads
ReadStructuredAsync(System.String path, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a file and extracts a bounded structured view.

Parameters

path System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadStructuredAsync(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads a stream and extracts a bounded structured view.

Parameters

stream System.IO.Stream required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadStructuredAsync(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions readerOptions, OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions structuredOptions, System.Threading.CancellationToken cancellationToken) #

Asynchronously reads bytes and extracts a bounded structured view.

Parameters

bytes System.Byte[] required
sourceName System.String required
readerOptions OfficeIMO.Reader.ReaderOptions required
structuredOptions OfficeIMO.Reader.OfficeDocumentStructuredExtractionOptions required
cancellationToken System.Threading.CancellationToken required
ReadTableExports 3 overloads
ReadTableExports(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns discovered tables with deterministic CSV, Markdown, and JSON payloads.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
indentedJson System.Boolean required
When true, writes indented table JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadTableExports(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns discovered tables with deterministic CSV, Markdown, and JSON payloads.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
indentedJson System.Boolean required
When true, writes indented table JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadTableExports(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns discovered tables with deterministic CSV, Markdown, and JSON payloads.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
indentedJson System.Boolean required
When true, writes indented table JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadTables 3 overloads
ReadTables(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns discovered tables in source order.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadTables(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns discovered tables in source order.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadTables(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns discovered tables in source order.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options. MaxTableRows is honored.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisualExports 3 overloads
ReadVisualExports(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns discovered visuals with deterministic payload and JSON sidecars.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
indentedJson System.Boolean required
When true, writes indented visual JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisualExports(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns discovered visuals with deterministic payload and JSON sidecars.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
indentedJson System.Boolean required
When true, writes indented visual JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisualExports(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Boolean indentedJson, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns discovered visuals with deterministic payload and JSON sidecars.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
indentedJson System.Boolean required
When true, writes indented visual JSON payloads.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisuals 3 overloads
ReadVisuals(System.String path, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document file and returns discovered visual payloads in source order.

Parameters

path System.String required
Source file path.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisuals(System.IO.Stream stream, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document stream and returns discovered visual payloads in source order.

Parameters

stream System.IO.Stream required
Source stream. This method does not close the stream.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.
ReadVisuals(System.Byte[] bytes, System.String sourceName, OfficeIMO.Reader.ReaderOptions options, System.Threading.CancellationToken cancellationToken) #

Reads a supported document from bytes and returns discovered visual payloads in source order.

Parameters

bytes System.Byte[] required
Source bytes.
sourceName System.String required
Optional source name used for kind detection and citations.
options OfficeIMO.Reader.ReaderOptions required
Extraction options.
cancellationToken System.Threading.CancellationToken required
Cancellation token.