Class Epub2Ncx

Parsed content of the EPUB 2 NCX (Navigation Center eXtended, also known as Navigation Control file for XML applications) document of the EPUB book. NCX document exposes the hierarchical structure of the book to allow the user to navigate through it.

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

Epub2Ncx

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 Epub2Ncx

Constructors

Epub2Ncx(string, Epub2NcxHead, string?, List<string>?, Epub2NcxNavigationMap, Epub2NcxPageList?, List<Epub2NcxNavigationList>?)

Initializes a new instance of the Epub2Ncx class.

Declaration

public Epub2Ncx(string filePath, Epub2NcxHead head, string? docTitle, List<string>? docAuthors, Epub2NcxNavigationMap navMap, Epub2NcxPageList? pageList = null, List<Epub2NcxNavigationList>? navLists = null)

Parameters

Type	Name	Description
string	filePath	The absolute path of the EPUB 2 NCX document file in the EPUB archive.
Epub2NcxHead	head	The NCX document head which contains all NCX metadata.
string	docTitle	The title of the EPUB book or null if the title is not provided.
List<string>	docAuthors	The list of authors of the EPUB book.
Epub2NcxNavigationMap	navMap	The NCX navigation map which acts as a container for one or more NCX navigation points for the primary navigation within the book (e.g. table of contents).
Epub2NcxPageList	pageList	The NCX page list containing one or more NCX page targets which provide pagination information or null if the NCX document doesn't have a page list.
List<Epub2NcxNavigationList>	navLists	A list of NCX navigation lists which contain distinct, flat sets of navigable elements for the secondary navigation within the book (e.g., lists of notes, figures, tables, etc.).

Exceptions

Type	Condition
ArgumentNullException	The filePath parameter is null.
ArgumentNullException	The head parameter is null.
ArgumentNullException	The navMap parameter is null.

Properties

DocAuthors

Gets the list of authors of the EPUB book.

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

Declaration

public List<string> DocAuthors { get; }

Property type: List<string>

DocTitle

Gets the title of the EPUB book or null if the title is not provided.

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

Declaration

public string? DocTitle { get; }

Property type: string

FilePath

Gets the absolute path of the EPUB 2 NCX document file in the EPUB archive.

Declaration

public string FilePath { get; }

Property type: string

Head

Gets the NCX document head which contains all NCX metadata.

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

Declaration

public Epub2NcxHead Head { get; }

Property type: Epub2NcxHead

NavLists

Gets a list of NCX navigation lists which contain distinct, flat sets of navigable elements for the secondary navigation within the book (e.g., lists of notes, figures, tables, etc.).

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

Declaration

public List<Epub2NcxNavigationList> NavLists { get; }

Property type: List<Epub2NcxNavigationList>

NavMap

Gets the NCX navigation map which acts as a container for one or more NCX navigation points for the primary navigation within the book (e.g. table of contents).

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

Declaration

public Epub2NcxNavigationMap NavMap { get; }

Property type: Epub2NcxNavigationMap

PageList

Gets the NCX page list containing one or more NCX page targets which provide pagination information or null if the NCX document doesn't have a page list.

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

Declaration

public Epub2NcxPageList? PageList { get; }

Property type: Epub2NcxPageList