Class EpubContentFile

The base class for content files and content file references declared in the EPUB manifest (e.g., HTML files or images).

Inheritance

object

EpubContentFile

EpubLocalContentFile

EpubRemoteContentFile

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub

Assembly: VersOne.Epub.dll

Syntax

public abstract class EpubContentFile

Constructors

View Source

EpubContentFile(string, EpubContentType, string)

Initializes a new instance of the EpubContentFile class.

Declaration

protected EpubContentFile(string key, EpubContentType contentType, string contentMimeType)

Parameters

Type	Name	Description
string	key	The content file key as it is declared in the EPUB manifest (in the Href property).
EpubContentType	contentType	The type of the content of the file.
string	contentMimeType	The MIME type of the content of the file.

Exceptions

Type	Condition
ArgumentNullException	The `contentMimeType` parameter is `null`.

Properties

View Source

ContentFileType

Gets the type of the content file (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

Key

Gets the content file 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 files) or an absolute URI of the content file outside of the EPUB archive (for remote content files).

Declaration

public string Key { get; }