The ncx type exposes the following members.

Constructors

  NameDescription
ncx
Instantiates the ncx class using the given NCX data in the form of an XML document.

Methods

  NameDescription
AddDocument
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
InsertAfter
Insert a navPoint in the NCX navMap for a new document. The new navPoint is inserted after the given navPoint and the playOrder of the following navPoint and all subsequent navPoints are renumbered (i.e. their playOrders are incremented). The new navPoint has an id set to the given value, its navLabel/text value, i.e. the text displayed to the user to identify the document, is set to the value of the text parameter. The 'src' attribute of the content element is set to the path held in the src parameter.
InsertBefore
Insert a navPoint in the NCX navMap for a new document. The new navPoint replaces the given navPoint in the playOrder and the displaced navPoint and all following navPoints are renumbered (i.e. their playOrders are incremented). The new navPoint has an id set to the given value, its navLabel/text value i.e. the text displayed to the user to identify the document is set to the value of the text parameter. The 'src' attribute of the content element is set to the path held in the src parameter.
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoveDown
Move the given content document to the next playOrder position, meaning it should appear later in the publication. This method provides one of the ways of reorganising and reordering a publication.
MoveUp
Move the given content document to the previous playOrder position, meaning it should appear earlier in the publication. This method provides one of the ways of reorganising and reordering a publication.
Remove
Remove the given content document from the NCX data. This will be done, for instance if a content document is removed altogether from the publication. After removal from the NCX, the playOrder of each successive content document is renumbered (decremented).
Rename
Changes to navLabel/text value for the given navPoint. This method can be used when a content provided (author/publisher) wishes to change the text of the table of contents.
Save
Save the NCX document back to disk. The NCX document is not saved to the .epub file by this method. That happens when the publication's package is saved.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
Author
Get or set the publication author in the docAuthor/text element of the NCX document.
Identifier
Get or set the dtb:uid meta element in the head element of the NCX.
NavMap
Get the navMap node of the NCX and return it as an XML document.
Publisher
Get or set the epub-creator meta element in the head element of the NCX.
Title
Get or set the publication title in the docTitle/text element of the NCX document.

See Also