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:

IRunAttrSource, IDocumentObject, IParagraphBase

public class TableOfContent
extends ParagraphBase

Constructor Summary

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

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

Method Summary

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

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, 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

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

TableOfContent

public TableOfContent(IDocument doc)

Initializes a new instance of the TableOfContent class.

Parameters:

doc - The doc.

TableOfContent

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

Initializes a new instance of the TableOfContent 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 a value indicating whether to use default heading styles.

Returns:

Using the default heading styles or NOT

setUseHeadingStyles

public void setUseHeadingStyles(boolean value)

Sets a value indicating whether to use default heading styles.

Parameters:

value - if it uses heading styles, set to true.

getUpperHeadingLevel

public int getUpperHeadingLevel()

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

Returns:

The upper heading level.

setUpperHeadingLevel

public void setUpperHeadingLevel(int value)

Sets the ending heading level of the table of content. Default value is 3.

Parameters:

value - The upper heading level.

getLowerHeadingLevel

public int getLowerHeadingLevel()

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

Returns:

The starting heading level.

setLowerHeadingLevel

public void setLowerHeadingLevel(int value)

Sets the starting heading level of the table of content. Default value is 1

Parameters:

value - The starting heading level.

getUseTableEntryFields

public boolean getUseTableEntryFields()

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

Returns:

Using the table entry fields or NOT

setUseTableEntryFields

public void setUseTableEntryFields(boolean value)

Sets a value indicating whether to use table entry fields.Default value is false.

Parameters:

value - if it uses table entry fields, set to true.

getTableID

public java.lang.String getTableID()

Gets the table ID.

Returns:

The table ID.

setTableID

public void setTableID(java.lang.String value)

Sets the table ID.

Parameters:

value - The table ID.

getRightAlignPageNumbers

public boolean getRightAlignPageNumbers()

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

Returns:

Showing the page number from the right side or NOT

setRightAlignPageNumbers

public void setRightAlignPageNumbers(boolean value)

Sets a value indicating whether to show page numbers from right side. Default value is true.

Parameters:

value - if right align of page numbers, set to true.

getIncludePageNumbers

public boolean getIncludePageNumbers()

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

Returns:

Showing the page numbers or NOT

setIncludePageNumbers

public void setIncludePageNumbers(boolean value)

Sets a value indicating whether to show page numbers. Default value is true.

Parameters:

value - if it includes page numbers, set to true.

getUseHyperlinks

public boolean getUseHyperlinks()

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

Returns:

Using the hyperlinks or NOT

setUseHyperlinks

public void setUseHyperlinks(boolean value)

Sets a value indicating whether to use hyperlinks.Default value is true.

Parameters:

value - if it uses hyperlinks, set to true.

getUseOutlineLevels

public boolean getUseOutlineLevels()

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

Returns:

Using the outline levels or NOT

setUseOutlineLevels

public void setUseOutlineLevels(boolean value)

Sets a value indicating whether use outline levels.Default value is false.

Parameters:

value - if it uses outline levels, set to true.

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:

The style name