Click or drag to resize

TableOfContent Class

Represents a table of contents in a document.
Inheritance Hierarchy

Namespace: Spire.Doc.Fields
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
Copy 
public class TableOfContent : ParagraphBase

The TableOfContent type exposes the following members.

Constructors
Name Description
Public method TableOfContent(IDocument)
Initializes a new instance of the TableOfContent class.
Public method TableOfContent(IDocument, String)
Initializes a new instance of the TableOfContent class.
Top
Properties
Name Description
Public property CharacterFormat
Gets the character format.
(Inherited from ParagraphBase .)
Public property ChildObjects
Gets the child objects of the entity.
(Inherited from ParagraphBase .)
Public property DeleteRevision
Gets the delete revision for this objects. Note this can be null. If null does not have delete revision.
(Inherited from ParagraphBase .)
Public property Document
Gets the document.
(Inherited from OwnerHolder .)
Public property DocumentObjectType
Gets the type of the document object.
(Overrides DocumentObject DocumentObjectType .)
Public property FirstChild
Gets the first child of the Element.
(Inherited from DocumentObject .)
Public property IncludePageNumbers
Gets or sets a value indicating whether to show page numbers. Default value is true.
Public property InsertRevision
Gets the insert revision for this objects. Note this can be null. If null does not have insert revision.
(Inherited from ParagraphBase .)
Public property IsComposite
Indicating whether this instance is composite.
(Inherited from DocumentObject .)
Public property IsDeleteRevision
Gets or set a value indicating whether this item was deleted from the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property IsInsertRevision
Gets a value indicating whether this item was inserted to the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property LastChild
Gets the last child of the Element.
(Inherited from DocumentObject .)
Public property LowerHeadingLevel
Gets or sets the starting heading level of the table of content. Default value is 1
Public property NextSibling
Gets the next sibling.
(Inherited from DocumentObject .)
Public property Owner
Gets the owner of this entity.
(Inherited from DocumentObject .)
Public property OwnerParagraph
Gets owner paragraph.
(Inherited from ParagraphBase .)
Public property PreviousSibling
Gets the previous sibling.
(Inherited from DocumentObject .)
Public property RightAlignPageNumbers
Gets or sets a value indicating whether to show page numbers from right side. Default value is true.
Public property StyleName
Gets the style name.
(Inherited from ParagraphBase .)
Public property TableID
Gets or sets the table ID.
Public property UpperHeadingLevel
Gets or sets the ending heading level of the table of content. Default value is 3.
Public property UseAbsolutePos
Gets or sets a value indicating whether absolute positioning should be used.
Public property UseHeadingStyles
Gets or sets a value indicating whether to use default heading styles.
Public property UseHyperlinks
Gets or sets a value indicating whether to use hyperlinks.Default value is true.
Public property UseOutlineLevels
Gets or sets a value indicating whether use outline levels.Default value is false.
Public property UseTableEntryFields
Gets or sets a value indicating whether to use table entry fields.Default value is false.
Protected property XDLSHolder (Inherited from DocumentSerializable .)
Top
Methods
Name Description
Public method ApplyCharacterFormat
Applies the specified character format to the current object.
(Inherited from ParagraphBase .)
Public method ApplyStyle
Applies the specified character style to the current object. If the specified style does not exist and the style name is "default paragraph font", a new built-in style is created and added to the document. If the specified style still cannot be found, an ArgumentException is thrown.
(Inherited from ParagraphBase .)
Public method Clone
Creates a duplicate of the document object.
(Inherited from DocumentObject .)
Protected method CloneImpl (Overrides ParagraphBase CloneImpl .)
Protected method CreateLayoutInfo (Overrides DocumentBase CreateLayoutInfo .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetNextWidgetSibling
Gets the next widget sibling.
(Inherited from ParagraphBase .)
Public method GetPreviousWidgetSibling
Gets the previous widget sibling.
(Inherited from ParagraphBase .)
Public method GetTOCLevelStyle
Gets the style name for TOC level.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method InitXDLSHolder (Overrides DocumentSerializable InitXDLSHolder .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method ReadXmlAttributes (Inherited from DocumentSerializable .)
Protected method ReadXmlContent (Inherited from DocumentSerializable .)
Protected method RestoreReference (Inherited from DocumentSerializable .)
Public method SetTOCLevelStyle
Sets the style for TOC level.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method ToString(String)
Exports the name and index in container of the object into a string in the specified seperator.
(Inherited from DocumentObject .)
Protected method WriteXmlAttributes (Overrides DocumentSerializable WriteXmlAttributes(IXDLSAttributeWriter) .)
Protected method WriteXmlContent (Inherited from DocumentSerializable .)
Top
Fields
Name Description
Protected field m_doc (Inherited from OwnerHolder .)
Top
See Also