Show / Hide Table of Contents

Class EpubContentFileRefMetadata

Metadata for a content file reference.

Inheritance
object
EpubContentFileRefMetadata
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 class EpubContentFileRefMetadata

Constructors

View Source

EpubContentFileRefMetadata(string, EpubContentType, string)

Initializes a new instance of the EpubContentFileRefMetadata class with a specified content file key, a content type of the file reference, and a MIME type of the file's content.

Declaration
public EpubContentFileRefMetadata(string key, EpubContentType contentType, string contentMimeType)
Parameters
Type Name Description
string key

The key of the content file 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 key parameter is null.

ArgumentException

The key parameter is an empty string.

ArgumentNullException

The contentMimeType parameter is null.

Properties

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; }
Property type: string
  • View Source
In this article
Back to top Generated by DocFX