Show / Hide Table of Contents

Class Epub3NavDocument

Parsed content of the EPUB 3 navigation document of the EPUB book. Navigation document includes human- and machine-readable content that facilitates navigation through the book.

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

Inheritance
object
Epub3NavDocument
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 Epub3NavDocument

Constructors

View Source

Epub3NavDocument(string, List<Epub3Nav>?)

Initializes a new instance of the Epub3NavDocument class.

Declaration
public Epub3NavDocument(string filePath, List<Epub3Nav>? navs = null)
Parameters
Type Name Description
string filePath

The absolute path of the EPUB 3 navigation document file in the EPUB archive.

List<Epub3Nav> navs

A list of navigation sections in the EPUB 3 navigation document.

Exceptions
Type Condition
ArgumentNullException

The filePath parameter is null.

Properties

View Source

FilePath

Gets the absolute path of the EPUB 3 navigation document file in the EPUB archive.

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

Navs

Gets a list of navigation sections in the EPUB 3 navigation document.

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

Declaration
public List<Epub3Nav> Navs { get; }
Property type: List<Epub3Nav>
  • View Source
In this article
Back to top Generated by DocFX