API Reference

Class

ReaderOptions

Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader.Core
Modifiers sealed

Options controlling extraction behavior for OfficeDocumentReader.

Inheritance

  • Object
  • ReaderOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Properties

public Nullable<Int64> MaxInputBytes { get; set; } #

Optional maximum input size in bytes enforced by OfficeDocumentReader when reading from a file or seekable stream. When null, a registered format handler may apply its documented default; otherwise 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 String OpenPassword { get; set; } #

Optional password used to open encrypted Office files when the selected reader engine supports decryption.

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 ComputeHashes { get; set; } #

When true, computes source/chunk hashes for incremental indexing workflows. Default: true.

public ReaderDetectionMode DetectionMode { get; set; } #

Controls extension/content detection during reads. The default inspects content only when the extension is unknown.

public Int32 DetectionMaxProbeBytes { get; set; } #

Maximum prefix bytes inspected when content detection runs. Default: 64 KiB.

public Int32 DetectionMaxContainerEntries { get; set; } #

Maximum ZIP entries inspected when classifying Office, Visio, EPUB, and ZIP containers. Default: 512.