Class EpubMetadataDescription

Represents a description 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.

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

Constructors

View Source

EpubMetadataDescription(string, string?, EpubTextDirection?, string?)

Initializes a new instance of the EpubMetadataDescription class.

Declaration
public EpubMetadataDescription(string description, string? id = null, EpubTextDirection? textDirection = null, string? language = null)
Parameters
Type Name Description
string description

The text content of this description.
string id

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

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

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

The description parameter is null.

Properties

View Source

Description

Gets the text content of this description.

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 string Description { get; }
Property type: string
View Source

Id

Gets the unique ID of this description or null if the description 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 description or null if the description 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

TextDirection

Gets the text direction of this description or null if the description 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?