Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

EpubReadOptions

Namespace OfficeIMO.Epub
Assembly OfficeIMO.Epub
Modifiers sealed

Controls EPUB extraction behavior.

Inheritance

  • Object
  • EpubReadOptions

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

Maximum compressed EPUB package size read from a file or stream.

public Int32 MaxArchiveEntries { get; set; } #

Maximum number of ZIP entries indexed from the container.

public Int64 MaxTotalUncompressedBytes { get; set; } #

Maximum combined uncompressed size declared by ZIP entries.

public Int64 MaxPackageMetadataBytes { get; set; } #

Maximum size of container, OPF, navigation, NCX, or encryption XML read into memory.

public Int32 MaxMetadataItems { get; set; } #

Maximum number of ordered OPF metadata declarations retained.

public Int32 MaxNavigationItems { get; set; } #

Maximum combined number of table-of-contents, page-list, and landmark items retained.

public Int32 MaxNavigationDepth { get; set; } #

Maximum retained navigation nesting depth.

public Int32 MaxChapters { get; set; } #

Maximum number of chapter entries to emit.

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

Optional maximum chapter size in bytes.

public Int64 MaxTotalRawHtmlBytes { get; set; } #

Maximum combined uncompressed bytes of raw chapter HTML retained in memory.

public Boolean IncludeRawHtml { get; set; } #

When true, includes raw HTML per chapter.

public Boolean IncludeResourceData { get; set; } #

When true, includes bounded manifest resource payloads.

public Int32 MaxResources { get; set; } #

Maximum number of manifest resources returned.

public Int64 MaxResourceBytes { get; set; } #

Maximum payload size for one manifest resource.

public Int64 MaxTotalResourceBytes { get; set; } #

Maximum combined payload size returned for manifest resources.

public Boolean DeterministicOrder { get; set; } #

When true, chapter order is deterministic by internal path.

public Boolean PreferSpineOrder { get; set; } #

When true, OPF spine ordering is preferred over archive path order.

public Boolean IncludeNonLinearSpineItems { get; set; } #

When false, non-linear OPF spine items are skipped.

public Boolean FallbackToHtmlScan { get; set; } #

When true, falls back to scanning XHTML/HTML entries when OPF/spine discovery fails.