Class EpubSchema

Parsed content of all EPUB schema files (OPF package and EPUB 2 NCX / EPUB 3 OPS navigation document) of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm for more information.

Inheritance

object

EpubSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub

Assembly: VersOne.Epub.dll

Syntax

public class EpubSchema

Constructors

EpubSchema(EpubPackage, Epub2Ncx?, Epub3NavDocument?, List<Smil>?, string)

Initializes a new instance of the EpubSchema class.

Declaration

public EpubSchema(EpubPackage package, Epub2Ncx? epub2Ncx, Epub3NavDocument? epub3NavDocument, List<Smil>? mediaOverlays, string contentDirectoryPath)

Parameters

Type	Name	Description
EpubPackage	package	The parsed content of the OPF package of the EPUB book.
Epub2Ncx	epub2Ncx	The parsed content of the EPUB 2 NCX document which is used for navigation within the EPUB 2 book or null if the NCX document is not present.
Epub3NavDocument	epub3NavDocument	The parsed content of the EPUB 3 navigation document of the book or null if the navigation document is not present.
List<Smil>	mediaOverlays	A list of all SMIL (EPUB media overlay) documents in the book.
string	contentDirectoryPath	The content directory path which acts as a root directory for all content files within the EPUB book.

Exceptions

Type	Condition
ArgumentNullException	The package parameter is null.
ArgumentNullException	The contentDirectoryPath parameter is null.

Properties

ContentDirectoryPath

Gets the content directory path which acts as a root directory for all content files within the EPUB book.

Declaration

public string ContentDirectoryPath { get; }

Property type: string

Epub2Ncx

Gets the parsed content of the EPUB 2 NCX document which is used for navigation within the EPUB 2 book or null if the NCX document is not present.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1 for more information.

Declaration

public Epub2Ncx? Epub2Ncx { get; }

Property type: Epub2Ncx

Epub3NavDocument

Gets the parsed content of the EPUB 3 navigation document of the book or null if the navigation document is not present.

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

Declaration

public Epub3NavDocument? Epub3NavDocument { get; }

Property type: Epub3NavDocument

MediaOverlays

Gets a list of all SMIL (EPUB media overlay) documents in the book.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html for more information.

Declaration

public List<Smil> MediaOverlays { get; }

Property type: List<Smil>

Package

Gets the parsed content of the OPF package of the EPUB book.

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

Declaration

public EpubPackage Package { get; }

Property type: EpubPackage