Class SpineReaderOptions

Various options to configure the behavior of the EPUB spine reader which is used for parsing the <spine> section of the EPUB OPF package file. This section represents the default reading order of the EPUB book.

Inheritance

object

SpineReaderOptions

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 SpineReaderOptions

Constructors

SpineReaderOptions(EpubReaderOptionsPreset?)

Initializes a new instance of the SpineReaderOptions class.

Declaration

public SpineReaderOptions(EpubReaderOptionsPreset? preset = null)

Parameters

Type	Name	Description
EpubReaderOptionsPreset?	preset	An optional preset to initialize the SpineReaderOptions class with a predefined set of options.

Properties

IgnoreMissingContentFiles

Gets or sets a value indicating whether EPUB spine reader should ignore the error when the content file referenced by a EPUB spine item is missing.

If it's set to false and and a EPUB spine item is referencing a manifest item which is pointing to a non-existent HTML file within the EPUB book, then the "Incorrect EPUB manifest: HTML content file with href = ... is missing in the book." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the reader will skip the invalid spine item. As a result, the ReadingOrder collection and the data returned by the GetReadingOrder() and the GetReadingOrderAsync() methods will be missing the text content referenced by the invalid spine item.

Default value is false.

Declaration

public bool IgnoreMissingContentFiles { get; set; }

Property type: bool

IgnoreMissingManifestItems

Gets or sets a value indicating whether EPUB spine reader should ignore the error when the manifest item referenced by a EPUB spine item is missing.

If it's set to false and the manifest item with the given ID is not present, then the "Incorrect EPUB spine: item with IdRef = ... is missing in the manifest" exception will be thrown. This exception can be suppressed by setting this property to true, in which case the reader will skip the invalid spine item. As a result, the ReadingOrder collection and the data returned by the GetReadingOrder() and the GetReadingOrderAsync() methods will be missing the text content referenced by the invalid spine item.

Default value is false.

Declaration

public bool IgnoreMissingManifestItems { get; set; }

Property type: bool

SkipSpineItemsReferencingRemoteContent

Gets or sets a value indicating whether EPUB spine reader should skip EPUB spine items referencing remote HTML files.

If it's set to false and a EPUB spine item is referencing a manifest item which is pointing to an external URL outside of the EPUB book, then the "Incorrect EPUB manifest: EPUB spine item ... cannot be a remote resource." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the reader will skip the invalid spine item. As a result, the ReadingOrder collection and the data returned by the GetReadingOrder() and the GetReadingOrderAsync() methods will be missing the text content referenced by the invalid spine item.

Default value is false.

Declaration

public bool SkipSpineItemsReferencingRemoteContent { get; set; }

Property type: bool