Class EpubManifestItem

An item within the EpubManifest. Represents a single content item of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem for more information.

Inheritance

object

EpubManifestItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VersOne.Epub.Schema

Assembly: VersOne.Epub.dll

Syntax

public class EpubManifestItem

Constructors

View Source

EpubManifestItem(string, string, string, List<EpubManifestProperty>?)

Initializes a new instance of the EpubManifestItem class with specified ID, href, media type, and properties.

Declaration

public EpubManifestItem(string id, string href, string mediaType, List<EpubManifestProperty>? properties = null)

Parameters

Type	Name	Description
string	id	The unique ID of this EPUB manifest item.
string	href	The URI to the content item represented by this EPUB manifest item.
string	mediaType	The MIME media type of the content item represented by this EPUB manifest item.
List<EpubManifestProperty>	properties	The list of properties of this EPUB manifest item or `null` if the manifest item doesn't declare properties.

Exceptions

Type	Condition
ArgumentNullException	The `id` parameter is `null`.
ArgumentNullException	The `href` parameter is `null`.
ArgumentNullException	The `mediaType` parameter is `null`.

View Source

EpubManifestItem(string, string, string, string?, string?, string?, string?, string?, List<EpubManifestProperty>?)

Initializes a new instance of the EpubManifestItem class with specified ID, href, media type, media overlay, required namespace, required modules, fallback, fallback style, and properties.

Declaration

public EpubManifestItem(string id, string href, string mediaType, string? mediaOverlay, string? requiredNamespace, string? requiredModules, string? fallback, string? fallbackStyle, List<EpubManifestProperty>? properties)

Parameters

Type	Name	Description
string	id	The unique ID of this EPUB manifest item.
string	href	The URI to the content item represented by this EPUB manifest item.
string	mediaType	The MIME media type of the content item represented by this EPUB manifest item.
string	mediaOverlay	The ID of the media overlay document for the content item represented by this EPUB manifest item or `null` if the content item doesn't have a media overlay document.
string	requiredNamespace	The namespace of the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or `null` if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.
string	requiredModules	A comma-separated list containing the names of the extended modules used in the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or `null` if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.
string	fallback	The ID of the fallback for the content item represented by this EPUB manifest item or `null` if the content item does not have a fallback.
string	fallbackStyle	The CSS stylesheet to render the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or `null` if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.
List<EpubManifestProperty>	properties	The list of properties of this EPUB manifest item or `null` if the manifest item doesn't declare properties.

Exceptions

Type	Condition
ArgumentNullException	The `id` parameter is `null`.
ArgumentNullException	The `href` parameter is `null`.
ArgumentNullException	The `mediaType` parameter is `null`.

Properties

View Source

Fallback

Gets the ID of the fallback for the content item represented by this EPUB manifest item or null if the content item does not have a fallback.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-item-fallback for more information.

Declaration

public string? Fallback { get; }

Property type: string

View Source

FallbackStyle

Gets the CSS stylesheet to render the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or null if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3.1.2 for more information.

Declaration

public string? FallbackStyle { get; }

Property type: string

View Source

Href

Gets the URI to the content item represented by this EPUB manifest item.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-href and https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem for more information.

Declaration

public string Href { get; }

Property type: string

View Source

Id

Gets the unique ID of this EPUB manifest item.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-id and https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem for more information.

Declaration

public string Id { get; }

Property type: string

View Source

MediaOverlay

Gets the ID of the media overlay document for the content item represented by this EPUB manifest item or null if the content item doesn't have a media overlay document.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-item-media-overlay for more information.

Declaration

public string? MediaOverlay { get; }

Property type: string

View Source

MediaType

Gets the MIME media type of the content item represented by this EPUB manifest item.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-item-media-type for more information.

Declaration

public string MediaType { get; }

Property type: string

View Source

Properties

Gets the list of properties of this EPUB manifest item or null if the manifest item doesn't declare properties.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-properties, https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem, and https://www.w3.org/publishing/epub32/epub-packages.html#app-item-properties-vocab for more information.

Declaration

public List<EpubManifestProperty>? Properties { get; }

Property type: List<EpubManifestProperty>

View Source

RequiredModules

Gets a comma-separated list containing the names of the extended modules used in the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or null if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3.1.2 for more information.

Declaration

public string? RequiredModules { get; }

Property type: string

View Source

RequiredNamespace

Gets the namespace of the EPUB 2 Out-Of-Line XML Island represented by this EPUB manifest item or null if the manifest item does not represent a EPUB 2 Out-Of-Line XML Island.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3.1.2 for more information.

Declaration

public string? RequiredNamespace { get; }

Property type: string

Methods

View Source

ToString()

Returns a string containing the values of the Id, Href, and MediaType properties for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
string	A string containing the values of the Id, Href, and MediaType properties.

Overrides

object.ToString()