Class EpubGuideReference

Reference element of the EpubGuide.

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

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

Constructors

View Source

EpubGuideReference(string, string?, string)

Initializes a new instance of the EpubGuideReference class.

Declaration
public EpubGuideReference(string type, string? title, string href)
Parameters
Type Name Description
string type

The type of the publication component referenced by the Href property.
string title

The title of the reference or null if the reference doesn't have a title.
string href

The link to a content document included in the manifest, with an optional fragment identifier.
Exceptions
Type Condition
ArgumentNullException

The type parameter is null.
ArgumentNullException

The href parameter is null.

Properties

View Source

Href

Gets the link to a content document included in the manifest, with an optional fragment identifier.

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

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

Title

Gets the title of the reference or null if the reference doesn't have a title.

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

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

Type

Gets the type of the publication component referenced by the Href property.

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

Declaration
public string Type { get; }
Property type: string

Methods

View Source

ToString()

Returns a string containing the values of the Type and Href properties for debugging purposes.

Declaration
public override string ToString()
Returns
Type Description
string

A string containing the values of the Type and Href properties.
Overrides