ApiTableOfContents

Class representing a table of contents.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	boolean	Removes the table of contents from the document.
GetClassType	"tableOfContents"	Returns a type of the ApiTableOfContents class.
GetIncludePageNumbers	boolean	Returns whether page numbers are shown in the table of contents.
GetLowerHeadingLevel	number	Returns the lowest (innermost) heading level included in the table of contents.
GetParent	ApiDocument | null	Returns the document that contains the table of contents.
GetRange	ApiRange | null	Returns a range that covers the entire table of contents.
GetRightAlignPageNumbers	boolean	Returns whether page numbers are right-aligned in the table of contents.
GetUpperHeadingLevel	number	Returns the highest (outermost) heading level included in the table of contents.
GetUseHyperlinks	boolean	Returns whether entries are formatted as hyperlinks.
SetIncludePageNumbers	boolean	Specifies whether page numbers are shown in the table of contents.
SetLowerHeadingLevel	boolean	Sets the lowest (innermost) heading level included in the table of contents.
SetPr	boolean	Applies the specified properties to the table of contents and rebuilds it.
SetRightAlignPageNumbers	boolean	Specifies whether page numbers are right-aligned in the table of contents.
SetUpperHeadingLevel	boolean	Sets the highest (outermost) heading level included in the table of contents.
SetUseHyperlinks	boolean	Specifies whether entries are formatted as hyperlinks.
Update	boolean	Updates the table of contents.