Show / Hide Table of Contents

Class EpubMetadata

Encapsulates meta information for the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-pkg-metadata and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2 for more information.

Inheritance
object
EpubMetadata
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: VersOne.Epub.Schema
Assembly: VersOne.Epub.dll
Syntax
public class EpubMetadata

Constructors

View Source

EpubMetadata(List<EpubMetadataTitle>?, List<EpubMetadataCreator>?, List<EpubMetadataSubject>?, List<EpubMetadataDescription>?, List<EpubMetadataPublisher>?, List<EpubMetadataContributor>?, List<EpubMetadataDate>?, List<EpubMetadataType>?, List<EpubMetadataFormat>?, List<EpubMetadataIdentifier>?, List<EpubMetadataSource>?, List<EpubMetadataLanguage>?, List<EpubMetadataRelation>?, List<EpubMetadataCoverage>?, List<EpubMetadataRights>?, List<EpubMetadataLink>?, List<EpubMetadataMeta>?)

Initializes a new instance of the EpubMetadata class.

Declaration
public EpubMetadata(List<EpubMetadataTitle>? titles = null, List<EpubMetadataCreator>? creators = null, List<EpubMetadataSubject>? subjects = null, List<EpubMetadataDescription>? descriptions = null, List<EpubMetadataPublisher>? publishers = null, List<EpubMetadataContributor>? contributors = null, List<EpubMetadataDate>? dates = null, List<EpubMetadataType>? types = null, List<EpubMetadataFormat>? formats = null, List<EpubMetadataIdentifier>? identifiers = null, List<EpubMetadataSource>? sources = null, List<EpubMetadataLanguage>? languages = null, List<EpubMetadataRelation>? relations = null, List<EpubMetadataCoverage>? coverages = null, List<EpubMetadataRights>? rights = null, List<EpubMetadataLink>? links = null, List<EpubMetadataMeta>? metaItems = null)
Parameters
Type Name Description
List<EpubMetadataTitle> titles

A list of titles of the EPUB book.

List<EpubMetadataCreator> creators

A list of creators of the EPUB book.

List<EpubMetadataSubject> subjects

A list of subjects of the EPUB book.

List<EpubMetadataDescription> descriptions

A list of descriptions of the EPUB book.

List<EpubMetadataPublisher> publishers

A list of publishers of the EPUB book.

List<EpubMetadataContributor> contributors

A list of names of persons, organizations, etc. that played a secondary role in the creation of the content of the EPUB book.

List<EpubMetadataDate> dates

A list of dates of the events associated with the EPUB book (e.g. publication date).

List<EpubMetadataType> types

A list of types of the EPUB book.

List<EpubMetadataFormat> formats

A list of file formats, physical media, or dimensions of the EPUB book.

List<EpubMetadataIdentifier> identifiers

A list of identifiers associated with the EPUB book, such as a UUID, DOI, or ISBN.

List<EpubMetadataSource> sources

A list of sources of the EPUB book.

List<EpubMetadataLanguage> languages

A list of languages of the content of the EPUB book.

List<EpubMetadataRelation> relations

A list of related resources of the EPUB book.

List<EpubMetadataCoverage> coverages

A list of coverages of the EPUB book.

List<EpubMetadataRights> rights

A list of rights held in and over the EPUB book.

List<EpubMetadataLink> links

A list of metadata links of the EPUB book.

List<EpubMetadataMeta> metaItems

A list of generic metadata items of the EPUB book.

Properties

View Source

Contributors

Gets a list of names of persons, organizations, etc. that played a secondary role in the creation of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dccontributor, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6, and http://purl.org/dc/elements/1.1/contributor for more information.

Declaration
public List<EpubMetadataContributor> Contributors { get; }
Property type: List<EpubMetadataContributor>
View Source

Coverages

Gets a list of coverages of the EPUB book. A coverage is the spatial or temporal topic of the book, the spatial applicability of the book, or the jurisdiction under which the book is relevant.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.14, and http://purl.org/dc/elements/1.1/coverage for more information.

Declaration
public List<EpubMetadataCoverage> Coverages { get; }
Property type: List<EpubMetadataCoverage>
View Source

Creators

Gets a list of creators. Each element in this list represents the name of a person, organization, etc. responsible for the creation of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dccreator, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.2, and http://purl.org/dc/elements/1.1/creator for more information.

Declaration
public List<EpubMetadataCreator> Creators { get; }
Property type: List<EpubMetadataCreator>
View Source

Dates

Gets a list of dates of the events associated with the EPUB book (e.g. publication date).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcdate, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7, and http://purl.org/dc/elements/1.1/date for more information.

Declaration
public List<EpubMetadataDate> Dates { get; }
Property type: List<EpubMetadataDate>
View Source

Descriptions

Gets a list of descriptions of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.4, and http://purl.org/dc/elements/1.1/description for more information.

Declaration
public List<EpubMetadataDescription> Descriptions { get; }
Property type: List<EpubMetadataDescription>
View Source

Formats

Gets a list of file formats, physical media, or dimensions of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.9, and http://purl.org/dc/elements/1.1/format for more information.

Declaration
public List<EpubMetadataFormat> Formats { get; }
Property type: List<EpubMetadataFormat>
View Source

Identifiers

Gets a list of identifiers associated with the EPUB book, such as a UUID, DOI, or ISBN.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcidentifier, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.10, and http://purl.org/dc/elements/1.1/identifier for more information.

Declaration
public List<EpubMetadataIdentifier> Identifiers { get; }
Property type: List<EpubMetadataIdentifier>
View Source

Languages

Gets a list of languages of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dclanguage, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.12, and http://purl.org/dc/elements/1.1/language for more information.

Declaration
public List<EpubMetadataLanguage> Languages { get; }
Property type: List<EpubMetadataLanguage>
View Source

Links

Gets a list of metadata links. Links are used to associate resources with the EPUB book, such as metadata records.

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

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

MetaItems

Gets a list of generic metadata items of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-meta-elem, https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf2-meta, and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2 for more information.

Declaration
public List<EpubMetadataMeta> MetaItems { get; }
Property type: List<EpubMetadataMeta>
View Source

Publishers

Gets a list of publishers of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.5, and http://purl.org/dc/elements/1.1/publisher for more information.

Declaration
public List<EpubMetadataPublisher> Publishers { get; }
Property type: List<EpubMetadataPublisher>
View Source

Relations

Gets a list of related resources of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.13, and http://purl.org/dc/elements/1.1/relation for more information.

Declaration
public List<EpubMetadataRelation> Relations { get; }
Property type: List<EpubMetadataRelation>
View Source

Rights

Gets a list of rights held in and over the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.15, and http://purl.org/dc/elements/1.1/rights for more information.

Declaration
public List<EpubMetadataRights> Rights { get; }
Property type: List<EpubMetadataRights>
View Source

Sources

Gets a list of sources. A source is a related resource from which the EPUB book is derived.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.11, and http://purl.org/dc/elements/1.1/source for more information.

Declaration
public List<EpubMetadataSource> Sources { get; }
Property type: List<EpubMetadataSource>
View Source

Subjects

Gets a list of subjects. Each element in this list identifies a subject of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcsubject, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.3, and http://purl.org/dc/elements/1.1/subject for more information.

Declaration
public List<EpubMetadataSubject> Subjects { get; }
Property type: List<EpubMetadataSubject>
View Source

Titles

Gets a list of titles. Each element in this list represents an instance of a name given to the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dctitle, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1, and http://purl.org/dc/elements/1.1/title for more information.

Declaration
public List<EpubMetadataTitle> Titles { get; }
Property type: List<EpubMetadataTitle>
View Source

Types

Gets a list of types of the EPUB book. Types are used to indicate that the EPUB book is of a specialized type (e.g., annotations or a dictionary packaged in EPUB format).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dctype, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.8, and http://purl.org/dc/elements/1.1/type for more information.

Declaration
public List<EpubMetadataType> Types { get; }
Property type: List<EpubMetadataType>
  • View Source
In this article
Back to top Generated by DocFX