Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ReaderFolderOptions

OfficeIMO.Reader

Namespace
OfficeIMO.Reader
Assembly
OfficeIMO.Reader.Core
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

Options controlling folder enumeration for OfficeDocumentReader.EnumerateFolder.

Inheritance

  • object
  • ReaderFolderOptions

Usage

Explore 6 API references to this type

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

Returned or exposed by 1

Accepted by parameters 5

Constructors

public ReaderFolderOptions() #

Properties

public bool Recurse { get; set; } #

When true, enumerates all subdirectories. Default: true.

public int MaxFiles { get; set; } #

Maximum number of files enumerated. Default: 500.

public int MaxTraversalEntries { get; set; } #

Maximum raw file-system entries inspected before filtering and deterministic sorting. Default: 10,000.

public long? MaxTotalBytes { get; set; } #

Optional maximum total bytes accepted for parsing across the folder operation. Files whose known size exceeds the remaining budget are skipped before their format handler runs. When source size metadata is unavailable, the cap is enforced after parsing as a best-effort fallback. When null, no cap is enforced.

public IReadOnlyList<string>? Extensions { get; set; } #

Optional allowed extensions (lower/upper insensitive). When null, a default set plus currently registered custom handler extensions is used. Examples: ".docx", ".xlsx", ".pptx", ".md".

public bool SkipReparsePoints { get; set; } #

When true, directory traversal skips file and directory reparse points (junctions/symlinks). Default: true.

public bool DeterministicOrder { get; set; } #

When true, folder traversal is deterministic (ordinal path ordering). Default: true.