Class EpubSpine

EPUB spine. Defines an ordered list of EpubSpineItemRef items that represent the default reading order of the EPUB book.

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

Inheritance

object

EpubSpine

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 EpubSpine

Constructors

EpubSpine(string?, EpubPageProgressionDirection?, string?, List<EpubSpineItemRef>?)

Initializes a new instance of the EpubSpine class.

Declaration

public EpubSpine(string? id = null, EpubPageProgressionDirection? pageProgressionDirection = null, string? toc = null, List<EpubSpineItemRef>? items = null)

Parameters

Type	Name	Description
string	id	The unique ID of this EPUB spine or null if the spine doesn't have an ID.
EpubPageProgressionDirection?	pageProgressionDirection	The page progression direction which defines the global direction in which the content flows or null if the spine doesn't specify a page progression direction.
string	toc	The value of the Id property of the EPUB 2 NCX file declared in the EpubManifest or null if the spine doesn't specify a EPUB 2 NCX file.
List<EpubSpineItemRef>	items	An ordered list of EpubSpineItemRef items that represent the default reading order of the EPUB book.

Properties

Id

Gets the unique ID of this EPUB spine or null if the spine doesn't have an ID.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-id for more information.

Declaration

public string? Id { get; }

Property type: string

Items

Gets an ordered list of EpubSpineItemRef items that represent the default reading order of the EPUB book.

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

Declaration

public List<EpubSpineItemRef> Items { get; }

Property type: List<EpubSpineItemRef>

PageProgressionDirection

Gets the page progression direction which defines the global direction in which the content flows or null if the spine doesn't specify a page progression direction.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-spine-page-progression-direction for more information.

Declaration

public EpubPageProgressionDirection? PageProgressionDirection { get; }

Property type: EpubPageProgressionDirection?

Toc

Gets the value of the Id property of the EPUB 2 NCX file declared in the EpubManifest or null if the spine doesn't specify a EPUB 2 NCX file.

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

Declaration

public string? Toc { get; }

Property type: string