Class EpubContentFileRef

The base class for content file references.

Inheritance
object
EpubContentFileRef
EpubLocalContentFileRef
EpubRemoteContentFileRef
Inherited Members
Namespace: VersOne.Epub
Assembly: VersOne.Epub.dll
Syntax
public abstract class EpubContentFileRef

Constructors

View Source

EpubContentFileRef(EpubContentFileRefMetadata, IEpubContentLoader)

Initializes a new instance of the EpubContentFileRef class with a specified metadata and a specified content loader.

Declaration
protected EpubContentFileRef(EpubContentFileRefMetadata metadata, IEpubContentLoader epubContentLoader)
Parameters
Type Name Description
EpubContentFileRefMetadata metadata

Metadata of this content file reference.
IEpubContentLoader epubContentLoader

A reference to the EPUB content loader which provides methods to load the content of this file.
Exceptions
Type Condition
ArgumentNullException

The metadata parameter is null.
ArgumentNullException

The epubContentLoader parameter is null.

Properties

View Source

ContentFileType

Gets the type of the content file reference (text or byte array).

Declaration
public abstract EpubContentFileType ContentFileType { get; }
Property type: EpubContentFileType
View Source

ContentLocation

Gets the location of the content file (local or remote).

Declaration
public abstract EpubContentLocation ContentLocation { get; }
Property type: EpubContentLocation
View Source

ContentMimeType

Gets the MIME type of the content of the file.

Declaration
public string ContentMimeType { get; }
Property type: string
View Source

ContentType

Gets the type of the content of the file (e.g. XHTML_1_1 or IMAGE_JPEG).

Declaration
public EpubContentType ContentType { get; }
Property type: EpubContentType
View Source

EpubContentLoader

Gets the reference to the EPUB content loader which provides methods to load the content of this file.

Declaration
protected IEpubContentLoader EpubContentLoader { get; }
Property type: IEpubContentLoader
View Source

Key

Gets the content file reference key as it is declared in the EPUB manifest (in the Href property). This is either a relative path of the content file within the EPUB archive (for local content file references) or an absolute URI of the content file outside of the EPUB archive (for remote content file references).

Declaration
public string Key { get; }
Property type: string
View Source

Metadata

Gets the metadata of this content file reference.

Declaration
protected EpubContentFileRefMetadata Metadata { get; }
Property type: EpubContentFileRefMetadata