Class Epub3Nav

Navigation section in the Epub3NavDocument.

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

Inheritance
object
Epub3Nav
Inherited Members
Namespace: VersOne.Epub.Schema
Assembly: VersOne.Epub.dll
Syntax
public class Epub3Nav

Constructors

View Source

Epub3Nav(Epub3StructuralSemanticsProperty?, bool, string?, Epub3NavOl)

Initializes a new instance of the Epub3Nav class with specified type, hidden flag, head, and navigation level.

Declaration
public Epub3Nav(Epub3StructuralSemanticsProperty? type, bool isHidden, string? head, Epub3NavOl ol)
Parameters
Type Name Description
Epub3StructuralSemanticsProperty? type

The type of the navigation section or null if the type is not specified.
bool isHidden

A value indicating whether the navigation section should be hidden from the reader or not.
string head

The header of the navigation section or null if the header is not present.
Epub3NavOl ol

The top navigation level of the navigation section (represented by the <ol> HTML tag in the navigation document).
Exceptions
Type Condition
ArgumentNullException

The ol parameter is null.
View Source

Epub3Nav(Epub3StructuralSemanticsProperty?, Epub3NavOl)

Initializes a new instance of the Epub3Nav class with specified type and navigation level.

Declaration
public Epub3Nav(Epub3StructuralSemanticsProperty? type, Epub3NavOl ol)
Parameters
Type Name Description
Epub3StructuralSemanticsProperty? type

The type of the navigation section or null if the type is not specified.
Epub3NavOl ol

The top navigation level of the navigation section (represented by the <ol> HTML tag in the navigation document).
Exceptions
Type Condition
ArgumentNullException

The ol parameter is null.

Properties

View Source

Head

Gets the header of the navigation section or null if the header is not present.

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

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

IsHidden

Gets a value indicating whether the navigation section should be hidden from the reader or not.

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

Declaration
public bool IsHidden { get; }
Property type: bool
View Source

Ol

Gets the top navigation level of the navigation section (represented by the <ol> HTML tag in the navigation document).

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

Declaration
public Epub3NavOl Ol { get; }
Property type: Epub3NavOl
View Source

Type

Gets the type of the navigation section or null if the type is not specified.

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

Declaration
public Epub3StructuralSemanticsProperty? Type { get; }
Property type: Epub3StructuralSemanticsProperty?