Class BookCoverReaderOptions

Various options to configure the behavior of the EPUB book cover reader which is used for loading the EPUB book cover image.

Inheritance

object

BookCoverReaderOptions

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 BookCoverReaderOptions

Constructors

BookCoverReaderOptions(EpubReaderOptionsPreset?)

Initializes a new instance of the BookCoverReaderOptions class.

Declaration

public BookCoverReaderOptions(EpubReaderOptionsPreset? preset = null)

Parameters

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

Properties

Epub2MetadataIgnoreMissingContent

Gets or sets a value indicating whether EPUB 2 book cover reader should ignore the error when the EPUB 2 cover metadata item contains an empty or a whitespace value.

If it's set to false and the EPUB 2 cover metadata node is empty or contains only whitespace characters, then the "Incorrect EPUB metadata: cover item content is missing." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the EPUB 2 book cover reader will ignore the invalid cover metadata item. The cover information may still be read from the EPUB 2 guide, if it's present there.

Default value is false.

Declaration

public bool Epub2MetadataIgnoreMissingContent { get; set; }

Property type: bool

Epub2MetadataIgnoreMissingContentFile

Gets or sets a value indicating whether EPUB 2 book cover reader should ignore the error when the image content file referenced by the EPUB 2 cover metadata item is missing.

If it's set to false and the content file referenced by the manifest item which in turn is referenced by the EPUB 2 cover metadata item is not present, then the "Incorrect EPUB manifest: item with href = ... is missing." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the EPUB 2 book cover reader will ignore the invalid item. The cover information may still be read from the EPUB 2 guide, if it's present there.

Default value is false.

Declaration

public bool Epub2MetadataIgnoreMissingContentFile { get; set; }

Property type: bool

Epub2MetadataIgnoreMissingManifestItem

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

If it's set to false and the manifest item with the given ID is not present, then the "Incorrect EPUB manifest: item with ID = ... referenced in EPUB 2 cover metadata is missing" exception will be thrown. This exception can be suppressed by setting this property to true, in which case the EPUB 2 book cover reader will ignore the invalid manifest item. The cover information may still be read from the EPUB 2 guide, if it's present there.

Default value is false.

Declaration

public bool Epub2MetadataIgnoreMissingManifestItem { get; set; }

Property type: bool

Epub3IgnoreMissingContentFile

Gets or sets a value indicating whether EPUB 3 book cover reader should ignore the error when the image content file referenced by the EPUB 3 cover manifest item is missing.

If it's set to false and the content file referenced by the cover manifest item is not present, then the "Incorrect EPUB manifest: item with href = ... is missing." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the EPUB 3 book cover reader will ignore the invalid item.

Default value is false.

Declaration

public bool Epub3IgnoreMissingContentFile { get; set; }

Property type: bool

IgnoreRemoteContentFileError

Gets or sets a value indicating whether EPUB book cover reader should ignore the error when the EPUB cover manifest item is referencing a remote resource.

If it's set to false and the content file referenced by the cover manifest item is a remote resource (i.e. the 'href' attribute of the manifest item is a remote URL), then the "Incorrect EPUB manifest: EPUB cover image ... cannot be a remote resource." exception will be thrown. This exception can be suppressed by setting this property to true, in which case the EPUB book cover reader will ignore the invalid item.

Default value is false.

Declaration

public bool IgnoreRemoteContentFileError { get; set; }

Property type: bool