Class Epub2NcxNavigationTarget

NCX navigation target which represents a navigable element for the secondary navigation within the book (e.g., lists of notes, figures, tables, etc.).

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Inheritance

object

Epub2NcxNavigationTarget

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 Epub2NcxNavigationTarget

Constructors

View Source

Epub2NcxNavigationTarget(string, List<Epub2NcxNavigationLabel>?, Epub2NcxContent?)

Initializes a new instance of the Epub2NcxNavigationTarget class with specified ID, navigation labels, and content.

Declaration

public Epub2NcxNavigationTarget(string id, List<Epub2NcxNavigationLabel>? navigationLabels, Epub2NcxContent? content)

Parameters

Type	Name	Description
string	id	The unique identifier of the navigation target.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the navigation target for the reader (e.g., a description of a footnote).
Epub2NcxContent	content	A pointer to the book's content associated with the navigation target or `null` if no such pointer is specified.

Exceptions

Type	Condition
ArgumentNullException	The `id` parameter is `null`.

View Source

Epub2NcxNavigationTarget(string, string?, string?, string?, List<Epub2NcxNavigationLabel>?, Epub2NcxContent?)

Initializes a new instance of the Epub2NcxNavigationTarget class with specified ID, class, value, play order, navigation labels, and content.

Declaration

public Epub2NcxNavigationTarget(string id, string? @class, string? value, string? playOrder, List<Epub2NcxNavigationLabel>? navigationLabels, Epub2NcxContent? content)

Parameters

Type	Name	Description
string	id	The unique identifier of the navigation target.
string	class	An optional description of the kind of structural unit the navigation target represents (e.g., 'note').
string	value	A positive integer representing the numeric value associated with the navigation point within the navigation list or `null` if no numeric value is provided.
string	playOrder	An optional positive integer denoting the location of the content of the navigation target in the reading order.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the navigation target for the reader (e.g., a description of a footnote).
Epub2NcxContent	content	A pointer to the book's content associated with the navigation target or `null` if no such pointer is specified.

Exceptions

Type	Condition
ArgumentNullException	The `id` parameter is `null`.

Properties

View Source

Class

Gets an optional description of the kind of structural unit the navigation target represents (e.g., 'note').

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public string? Class { get; }

Property type: string

View Source

Content

Gets a pointer to the book's content associated with the navigation target or null if no such pointer is specified.

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public Epub2NcxContent? Content { get; }

Property type: Epub2NcxContent

View Source

Id

Gets the unique identifier of the navigation target.

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public string Id { get; }

Property type: string

View Source

NavigationLabels

Gets a list of navigation labels providing textual description of the navigation target for the reader (e.g., a description of a footnote). A single navigation target can contain multiple labels in different languages.

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public List<Epub2NcxNavigationLabel> NavigationLabels { get; }

Property type: List<Epub2NcxNavigationLabel>

View Source

PlayOrder

Gets an optional positive integer denoting the location of the content of the navigation target in the reading order.

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public string? PlayOrder { get; }

Property type: string

View Source

Value

Gets a positive integer representing the numeric value associated with the navigation point within the navigation list or null if no numeric value is provided.

See http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Declaration

public string? Value { get; }