com.spire.doc.fields
Class TableOfContent

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.TableOfContent

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IParagraphBase

public class TableOfContent
extends ParagraphBase

Constructor Summary

TableOfContent(IDocument doc)
Initializes a new instance of the class.

TableOfContent(IDocument doc, java.lang.String switches)
Initializes a new instance of the class.

Method Summary

DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
boolean	getIncludePageNumbers() Gets or sets a value indicating whether to show page numbers.
int	getLowerHeadingLevel() Gets or sets the starting heading level of the table of content.
boolean	getRightAlignPageNumbers() Gets or sets a value indicating whether to show page numbers from right side.
java.lang.String	getTableID() Gets or sets the table ID.
java.lang.String	getTOCLevelStyle(int levelNumber) Gets the style name for TOC level.
int	getUpperHeadingLevel() Gets or sets the ending heading level of the table of content.
boolean	getUseAbsolutePos()
boolean	getUseHeadingStyles() Gets or sets a value indicating whether to use default heading styles.
boolean	getUseHyperlinks() Gets or sets a value indicating whether to use hyperlinks.Default value is true.
boolean	getUseOutlineLevels() Gets or sets a value indicating whether use outline levels.Default value is false.
boolean	getUseTableEntryFields() Gets or sets a value indicating whether to use table entry fields.Default value is false.
void	setIncludePageNumbers(boolean value) Gets or sets a value indicating whether to show page numbers.
void	setLowerHeadingLevel(int value) Gets or sets the starting heading level of the table of content.
void	setRightAlignPageNumbers(boolean value) Gets or sets a value indicating whether to show page numbers from right side.
void	setTableID(java.lang.String value) Gets or sets the table ID.
void	setTOCLevelStyle(int levelNumber, java.lang.String styleName) Sets the style for TOC level.
void	setUpperHeadingLevel(int value) Gets or sets the ending heading level of the table of content.
void	setUseAbsolutePos(boolean value)
void	setUseHeadingStyles(boolean value) Gets or sets a value indicating whether to use default heading styles.
void	setUseHyperlinks(boolean value) Gets or sets a value indicating whether to use hyperlinks.Default value is true.
void	setUseOutlineLevels(boolean value) Gets or sets a value indicating whether use outline levels.Default value is false.
void	setUseTableEntryFields(boolean value) Gets or sets a value indicating whether to use table entry fields.Default value is false.

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getCharacterFormat, getChildObjects, getDeleteRevision, getInsertRevision, getNextWidgetSibling, getOwnerParagraph, getPreviousWidgetSibling, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

TableOfContent

public TableOfContent(IDocument doc)

Initializes a new instance of the class.

Parameters:

doc - The doc.

TableOfContent

public TableOfContent(IDocument doc,
                      java.lang.String switches)

Initializes a new instance of the class.

Parameters:

doc - The doc.

switches - The switches.

Method Detail

getUseAbsolutePos

public boolean getUseAbsolutePos()

setUseAbsolutePos

public void setUseAbsolutePos(boolean value)

getUseHeadingStyles

public boolean getUseHeadingStyles()

Gets or sets a value indicating whether to use default heading styles.

Returns:

if it uses heading styles, set to true.

setUseHeadingStyles

public void setUseHeadingStyles(boolean value)

Gets or sets a value indicating whether to use default heading styles.

getUpperHeadingLevel

public int getUpperHeadingLevel()

Gets or sets the ending heading level of the table of content. Default value is 3.

Returns:

The upper heading level.

setUpperHeadingLevel

public void setUpperHeadingLevel(int value)

Gets or sets the ending heading level of the table of content. Default value is 3.

getLowerHeadingLevel

public int getLowerHeadingLevel()

Gets or sets the starting heading level of the table of content. Default value is 1

Returns:

The starting heading level.

setLowerHeadingLevel

public void setLowerHeadingLevel(int value)

Gets or sets the starting heading level of the table of content. Default value is 1

getUseTableEntryFields

public boolean getUseTableEntryFields()

Gets or sets a value indicating whether to use table entry fields.Default value is false.

Returns:

if it uses table entry fields, set to true.

setUseTableEntryFields

public void setUseTableEntryFields(boolean value)

Gets or sets a value indicating whether to use table entry fields.Default value is false.

getTableID

public java.lang.String getTableID()

Gets or sets the table ID.

Returns:

The table ID.

setTableID

public void setTableID(java.lang.String value)

Gets or sets the table ID.

getRightAlignPageNumbers

public boolean getRightAlignPageNumbers()

Gets or sets a value indicating whether to show page numbers from right side. Default value is true.

Returns:

if right align of page numbers, set to true.

setRightAlignPageNumbers

public void setRightAlignPageNumbers(boolean value)

Gets or sets a value indicating whether to show page numbers from right side. Default value is true.

getIncludePageNumbers

public boolean getIncludePageNumbers()

Gets or sets a value indicating whether to show page numbers. Default value is true.

Returns:

if it includes page numbers, set to true.

setIncludePageNumbers

public void setIncludePageNumbers(boolean value)

Gets or sets a value indicating whether to show page numbers. Default value is true.

getUseHyperlinks

public boolean getUseHyperlinks()

Gets or sets a value indicating whether to use hyperlinks.Default value is true.

Returns:

if it uses hyperlinks, set to true.

setUseHyperlinks

public void setUseHyperlinks(boolean value)

Gets or sets a value indicating whether to use hyperlinks.Default value is true.

getUseOutlineLevels

public boolean getUseOutlineLevels()

Gets or sets a value indicating whether use outline levels.Default value is false.

Returns:

if it uses outline levels, set to true.

setUseOutlineLevels

public void setUseOutlineLevels(boolean value)

Gets or sets a value indicating whether use outline levels.Default value is false.

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Specified by:

getDocumentObjectType in class DocumentObject

Returns:

The type of the document object.

setTOCLevelStyle

public void setTOCLevelStyle(int levelNumber,
                             java.lang.String styleName)

Sets the style for TOC level.

Parameters:

levelNumber - The level number.

styleName - Name of the style.

getTOCLevelStyle

public java.lang.String getTOCLevelStyle(int levelNumber)

Gets the style name for TOC level.

Parameters:

levelNumber - The level number.

Returns: