Class Epub2NcxPageTarget

NCX page target. It provides pagination information for a single page within the EPUB book.

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

Epub2NcxPageTarget

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 Epub2NcxPageTarget

Constructors

Epub2NcxPageTarget(string?, string?, Epub2NcxPageTargetType, string?, string?, List<Epub2NcxNavigationLabel>?, Epub2NcxContent?)

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

Declaration

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

Parameters

Type	Name	Description
string	id	The optional unique identifier of the page target.
string	value	A positive integer representing the numeric value associated with a page or null if no numeric value is provided.
Epub2NcxPageTargetType	type	The type of the page represented by the page target.
string	class	An optional description of the kind of the page represented by the page target.
string	playOrder	An optional positive integer denoting the location of the page content in the reading order.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the page target for the reader.
Epub2NcxContent	content	A pointer to the book's content associated with the page target or null if no such pointer is specified.

Epub2NcxPageTarget(Epub2NcxPageTargetType, List<Epub2NcxNavigationLabel>?, Epub2NcxContent?)

Initializes a new instance of the Epub2NcxPageTarget class with specified type, navigation labels, and content.

Declaration

public Epub2NcxPageTarget(Epub2NcxPageTargetType type, List<Epub2NcxNavigationLabel>? navigationLabels, Epub2NcxContent? content)

Parameters

Type	Name	Description
Epub2NcxPageTargetType	type	The type of the page represented by the page target.
List<Epub2NcxNavigationLabel>	navigationLabels	A list of navigation labels providing textual description of the page target for the reader.
Epub2NcxContent	content	A pointer to the book's content associated with the page target or null if no such pointer is specified.

Properties

Class

Gets an optional description of the kind of the page represented by the page target.

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 page 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

Id

Gets the optional unique identifier of the page target.

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 page target for the reader. A single page 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>

PlayOrder

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

Type

Gets the type of the page represented by the page target.

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

Declaration

public Epub2NcxPageTargetType Type { get; }

Property type: Epub2NcxPageTargetType

Value

Gets a positive integer representing the numeric value associated with a page 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; }

Property type: string