Class Epub3NavAnchor

Navigation link associated with a Epub3NavLi (represented by the <a> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

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

Constructors

View Source

Epub3NavAnchor(string?, string, string?, string?, Epub3StructuralSemanticsProperty?)

Initializes a new instance of the Epub3NavAnchor class.

Declaration
public Epub3NavAnchor(string? href, string text, string? title = null, string? alt = null, Epub3StructuralSemanticsProperty? type = null)
Parameters
Type Name Description
string href

An IRI that resolves to a content document or a fragment within the EPUB book (represented by the 'href' HTML attribute in the navigation document) or null if the anchor doesn't contain an IRI.
string text

The textual content of the navigation link (represented by the inner content of the <a> HTML tag in the navigation document).
string title

The alternative title of the navigation link (represented by the 'title' HTML attribute in the navigation document) or null if the alternative title is not specified.
string alt

The alternative text of the navigation link (represented by the 'title' HTML attribute in the navigation document) or null if the alternative text is not specified.
Epub3StructuralSemanticsProperty? type

The type of the structural semantics of the navigation link (represented by the 'epub:type' HTML attribute in the navigation document) or null if the anchor doesn't specify a type.
Exceptions
Type Condition
ArgumentNullException

The text parameter is null.

Properties

View Source

Alt

Gets the alternative text of the navigation link (represented by the 'title' HTML attribute in the navigation document) or null if the alternative text is not specified.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

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

Href

Gets an IRI that resolves to a content document or a fragment within the EPUB book (represented by the 'href' HTML attribute in the navigation document) or null if the anchor doesn't contain an IRI.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

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

Text

Gets the textual content of the navigation link (represented by the inner content of the <a> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

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

Title

Gets the alternative title of the navigation link (represented by the 'title' HTML attribute in the navigation document) or null if the alternative title is not specified.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

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

Type

Gets the type of the structural semantics of the navigation link (represented by the 'epub:type' HTML attribute in the navigation document) or null if the anchor doesn't specify a type.

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

Declaration
public Epub3StructuralSemanticsProperty? Type { get; }
Property type: Epub3StructuralSemanticsProperty?