API Reference
ReaderOptions
Options controlling extraction behavior for DocumentReader.
Inheritance
- Object
- ReaderOptions
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
- Property ReaderHandlerRegistration.ReadPath
- Property ReaderHandlerRegistration.ReadStream
Accepted by parameters
- Method DocumentReader.ExtractMarkdownTables
- Method DocumentReader.Read
- Method DocumentReader.Read
- Method DocumentReader.Read
- Method DocumentReader.ReadAssets
- Method DocumentReader.ReadAssets
- Method DocumentReader.ReadAssets
- Method DocumentReader.ReadDocument
- Method DocumentReader.ReadDocument
- Method DocumentReader.ReadDocument
- Method DocumentReader.ReadDocumentJson
- Method DocumentReader.ReadDocumentJson
- Method DocumentReader.ReadDocumentJson
- Method DocumentReader.ReadFolder
- Method DocumentReader.ReadFolder
- Method DocumentReader.ReadFolderDetailed
- Method DocumentReader.ReadFolderDocuments
- Method DocumentReader.ReadPathDocumentsDetailed
- Method DocumentReader.ReadTableExports
- Method DocumentReader.ReadTableExports
- Method DocumentReader.ReadTableExports
- Method DocumentReader.ReadTables
- Method DocumentReader.ReadTables
- Method DocumentReader.ReadTables
- Method DocumentReader.ReadVisualExports
- Method DocumentReader.ReadVisualExports
- Method DocumentReader.ReadVisualExports
- Method DocumentReader.ReadVisuals
- Method DocumentReader.ReadVisuals
- Method DocumentReader.ReadVisuals
Constructors
public ReaderOptions() #Inherited Methods
Properties
public Nullable<Int64> MaxInputBytes { get; set; } #Optional maximum input size in bytes enforced by DocumentReader when reading from a file or seekable stream. When null, no size limit is enforced.
public Nullable<Int64> OpenXmlMaxCharactersInPart { get; set; } #OpenXML security: maximum characters allowed per part when opening OpenXML packages (best-effort). When null, the OpenXML SDK default is used.
public Nullable<Int32> MaxOpenXmlImageAssets { get; set; } #OpenXML security: maximum image asset entries emitted from an Office package. When null, no image asset entry limit is enforced.
public Nullable<Int32> MaxOpenXmlImagePlacementsPerRelationship { get; set; } #OpenXML security: maximum placements emitted for one image relationship. When null, no per-relationship placement limit is enforced.
public Nullable<Int64> MaxOpenXmlImageAssetBytes { get; set; } #OpenXML security: maximum bytes read from a single image part. When null, no individual image payload limit is enforced.
public Nullable<Int64> MaxOpenXmlImageTotalAssetBytes { get; set; } #OpenXML security: maximum unique image payload bytes retained while extracting assets. Repeated placements of the same image part count once toward this limit. When null, no total image payload limit is enforced.
public Int32 MaxChars { get; set; } #Maximum characters per emitted chunk (best-effort).
public Int32 MaxTableRows { get; set; } #Maximum number of table rows included per table chunk (best-effort).
public Boolean IncludeWordFootnotes { get; set; } #When true, include Word footnotes as a final chunk. Default: true.
public Boolean IncludePowerPointNotes { get; set; } #When true, include PowerPoint speaker notes when present. Default: true.
public Boolean ExcelHeadersInFirstRow { get; set; } #Excel: when true, treat the first row as headers. Default: true.
public Int32 ExcelChunkRows { get; set; } #Excel: number of worksheet rows per emitted chunk. Default: 200.
public String ExcelSheetName { get; set; } #Excel: optional sheet name. When null, all sheets are extracted.
public String ExcelA1Range { get; set; } #Excel: optional A1 range. When null, the sheet's used range is used.
public Boolean MarkdownChunkByHeadings { get; set; } #Markdown: when true, chunk by headings where possible. Default: true.
public MarkdownInputNormalizationOptions MarkdownInputNormalization { get; set; } #Markdown: optional input normalization applied before parser-aware chunking. This is intended for compact AI/chat markdown fixes while preserving default strict behavior when null.
public Boolean ComputeHashes { get; set; } #When true, computes source/chunk hashes for incremental indexing workflows. Default: true.