Class EpubCollection

Represents a unified collection of EPUB metadata items. A collection allows resources to be assembled into logical groups for a variety of potential uses: enabling content that has been split across multiple EPUB Content Documents to be reassembled back into a meaningful unit (e.g., an index split across multiple documents), identifying resources for specialized purposes (e.g., preview content), or collecting together resources that present additional information about this EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#elemdef-collection for more information.

Inheritance
object
EpubCollection
Inherited Members
Namespace: VersOne.Epub.Schema
Assembly: VersOne.Epub.dll
Syntax
public class EpubCollection

Constructors

View Source

EpubCollection(string, EpubMetadata?, List<EpubCollection>?, List<EpubMetadataLink>?, string?, EpubTextDirection?, string?)

Initializes a new instance of the EpubCollection class.

Declaration
public EpubCollection(string role, EpubMetadata? metadata = null, List<EpubCollection>? nestedCollections = null, List<EpubMetadataLink>? links = null, string? id = null, EpubTextDirection? textDirection = null, string? language = null)
Parameters
Type Name Description
string role

The role of this collection.
EpubMetadata metadata

The EPUB meta information included into this collection or null if the collection doesn't have any meta information.
List<EpubCollection> nestedCollections

A list of sub-collections included in this collection.
List<EpubMetadataLink> links

A list of metadata links.
string id

The unique ID of this collection or null if the collection doesn't have an ID.
EpubTextDirection? textDirection

The text direction of this collection or null if the collection doesn't specify a text direction.
string language

The language of this collection or null if the collection doesn't specify the language.
Exceptions
Type Condition
ArgumentNullException

The role parameter is null.

Properties

View Source

Id

Gets the unique ID of this collection or null if the collection doesn't have an ID.

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

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

Language

Gets the language of this collection or null if the collection doesn't specify the language.

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

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

Gets a list of metadata links. Links are used to associate resources with this collection, such as metadata records.

See https://www.w3.org/publishing/epub32/epub-packages.html#elemdef-collection-link for more information.

Declaration
public List<EpubMetadataLink> Links { get; }
Property type: List<EpubMetadataLink>
View Source

Metadata

Gets the EPUB meta information included into this collection or null if the collection doesn't have any meta information.

See https://www.w3.org/publishing/epub32/epub-packages.html#elemdef-collection-metadata for more information.

Declaration
public EpubMetadata? Metadata { get; }
Property type: EpubMetadata
View Source

NestedCollections

Gets a list of sub-collections included in this collection.

See https://www.w3.org/publishing/epub32/epub-packages.html#elemdef-collection for more information.

Declaration
public List<EpubCollection> NestedCollections { get; }
Property type: List<EpubCollection>
View Source

Role

Gets the role of this collection.

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

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

TextDirection

Gets the text direction of this collection or null if the collection doesn't specify a text direction.

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

Declaration
public EpubTextDirection? TextDirection { get; }
Property type: EpubTextDirection?