Class EpubSpineItemRef

An element of the EpubSpine list which references a EpubManifestItem declared in the EpubManifest. The order of the EpubSpineItemRef items in the EpubSpine list defines the default reading order of the EPUB book.

See https://www.w3.org/TR/epub-33/#sec-itemref-elem and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4 for more information.

Inheritance

object

EpubSpineItemRef

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VersOne.Epub.Schema

Assembly: VersOne.Epub.dll

Syntax

public class EpubSpineItemRef

Constructors

EpubSpineItemRef(string)

Initializes a new instance of the EpubSpineItemRef class with the specified ID ref.

Declaration

public EpubSpineItemRef(string idRef)

Parameters

Type	Name	Description
string	idRef	The value of the Id property of an item declared in the EpubManifest this EPUB spine element is referencing to.

Exceptions

Type	Condition
ArgumentNullException	The idRef parameter is null.

EpubSpineItemRef(string?, string, bool, List<EpubSpineProperty>?)

Initializes a new instance of the EpubSpineItemRef class with specified ID, ID ref, linear indicator, and properties.

Declaration

public EpubSpineItemRef(string? id, string idRef, bool isLinear, List<EpubSpineProperty>? properties = null)

Parameters

Type	Name	Description
string	id	The unique ID of this EPUB spine element or null if the spine doesn't have an ID.
string	idRef	The value of the Id property of an item declared in the EpubManifest this EPUB spine element is referencing to.
bool	isLinear	A value indicating whether the referenced EpubManifestItem contains content that contributes to the primary reading order and has to be read sequentially (true) or auxiliary content that enhances or augments the primary content and can be accessed out of sequence (false).
List<EpubSpineProperty>	properties	A list of additional EPUB spine element properties or null if the spine doesn't specify properties.

Exceptions

Type	Condition
ArgumentNullException	The idRef parameter is null.

Properties

Id

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

See https://www.w3.org/TR/epub-33/#attrdef-id for more information.

Declaration

public string? Id { get; }

Property type: string

IdRef

Gets the value of the Id property of an item declared in the EpubManifest this EPUB spine element is referencing to.

See https://www.w3.org/TR/epub-33/#attrdef-itemref-idref and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4 for more information.

Declaration

public string IdRef { get; }

Property type: string

IsLinear

Gets a value indicating whether the referenced EpubManifestItem contains content that contributes to the primary reading order and has to be read sequentially (true) or auxiliary content that enhances or augments the primary content and can be accessed out of sequence (false).

See https://www.w3.org/TR/epub-33/#attrdef-itemref-linear and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4 for more information.

Declaration

public bool IsLinear { get; }

Property type: bool

Properties

Gets a list of additional EPUB spine element properties or null if the spine doesn't specify properties.

See https://www.w3.org/TR/epub-33/#app-itemref-properties-vocab for more information.

Declaration

public List<EpubSpineProperty>? Properties { get; }

Property type: List<EpubSpineProperty>

Methods

ToString()

Returns a string containing the values of the Id and IdRef properties for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
string	A string containing the values of the Id and IdRef properties.

Overrides

object.ToString()