Class Epub2NcxNavigationPoint

NCX navigation point which contains a description of the target and a pointer to content. It is used for the primary navigation within the book (e.g., for the table of contents).

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

Epub2NcxNavigationPoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VersOne.Epub.Schema

Assembly: VersOne.Epub.dll

Syntax

public class Epub2NcxNavigationPoint

Constructors

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

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

Declaration

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

Parameters

Type	Name	Description
string	id	The unique identifier of the navigation point.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the navigation point for the reader.
Epub2NcxContent	content	A pointer to the book's content associated with the navigation point.

Exceptions

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

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

Initializes a new instance of the Epub2NcxNavigationPoint class with specified ID, class, play order, navigation labels, content, and child navigation points.

Declaration

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

Parameters

Type	Name	Description
string	id	The unique identifier of the navigation point.
string	class	An optional description of the kind of structural unit the navigation point represents (e.g., 'chapter', 'section').
string	playOrder	An optional positive integer denoting the location of the content of the navigation point in the reading order.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the navigation point for the reader.
Epub2NcxContent	content	A pointer to the book's content associated with the navigation point.
List<Epub2NcxNavigationPoint>	childNavigationPoints	A list of child navigation points constituting the nested navigational hierarchy within the navigation point.

Exceptions

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

Properties

ChildNavigationPoints

Gets a list of child navigation points constituting the nested navigational hierarchy within the navigation point.

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

Declaration

public List<Epub2NcxNavigationPoint> ChildNavigationPoints { get; }

Property type: List<Epub2NcxNavigationPoint>

Class

Gets an optional description of the kind of structural unit the navigation point represents (e.g., 'chapter', 'section').

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

Declaration

public string? Class { get; }

Property type: string

Content

Gets a pointer to the book's content associated with the navigation point.

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

Declaration

public Epub2NcxContent Content { get; }

Property type: Epub2NcxContent

Id

Gets the unique identifier of the navigation point.

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

Declaration

public string Id { get; }

Property type: string

NavigationLabels

Gets a list of navigation labels providing textual description of the navigation point for the reader. It generally contains the heading of the referenced section of the book. A single navigation point 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>

PlayOrder

Gets an optional positive integer denoting the location of the content of the navigation point 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

Methods

ToString()

Returns a string containing the values of the Id and Source properties for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
string	A string containing the values of the Id and Source properties.

Overrides

object.ToString()