Show / Hide Table of Contents

Class PackageReaderOptions

Various options to configure the behavior of the EPUB package reader.

Inheritance
object
PackageReaderOptions
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: VersOne.Epub.Options
Assembly: VersOne.Epub.dll
Syntax
public class PackageReaderOptions

Constructors

View Source

PackageReaderOptions(EpubReaderOptionsPreset?)

Initializes a new instance of the PackageReaderOptions class.

Declaration
public PackageReaderOptions(EpubReaderOptionsPreset? preset = null)
Parameters
Type Name Description
EpubReaderOptionsPreset? preset

An optional preset to initialize the PackageReaderOptions class with a predefined set of options.

Properties

View Source

IgnoreMissingToc

Gets or sets a value indicating whether the package reader should ignore missing TOC attribute in the EPUB 2 spine. If it's set to false and the TOC attribute is not present, then the "Incorrect EPUB spine: TOC is missing" exception will be thrown. Default value is false.

Declaration
public bool IgnoreMissingToc { get; set; }
Property type: bool
View Source

SkipInvalidManifestItems

Gets or sets a value indicating whether the package reader should skip EPUB manifest items that are missing required attributes (id, href, or media-type). If it's set to false and one of the required attributes is not present, then one of the "Incorrect EPUB manifest: item ... is missing" exceptions will be thrown. Default value is false.

Declaration
public bool SkipInvalidManifestItems { get; set; }
Property type: bool
  • View Source
In this article
Back to top Generated by DocFX