ApiTableOfContents

表示目录的类。

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

方法

下表列出了可用的方法。

方法	返回值	描述
Delete	boolean	从文档中移除目录。
GetClassType	"tableOfContents"	返回 ApiTableOfContents 类的类型。
GetIncludePageNumbers	boolean	返回目录中是否显示页码。
GetLowerHeadingLevel	number	返回目录中包含的最低（最内层）标题级别。
GetParent	ApiDocument | null	返回包含该目录的文档。
GetRange	ApiRange | null	返回覆盖整个目录的范围。
GetRightAlignPageNumbers	boolean	返回目录中的页码是否右对齐。
GetUpperHeadingLevel	number	返回目录中包含的最高（最外层）标题级别。
GetUseHyperlinks	boolean	返回条目是否设置为超链接格式。
SetIncludePageNumbers	boolean	指定是否在目录中显示页码。
SetLowerHeadingLevel	boolean	设置目录中包含的最低（最内层）标题级别。
SetPr	boolean	将指定属性应用于目录并重新生成目录。
SetRightAlignPageNumbers	boolean	指定目录中的页码是否右对齐。
SetUpperHeadingLevel	boolean	设置目录中包含的最高（最外层）标题级别。
SetUseHyperlinks	boolean	指定是否将条目设置为超链接格式。
Update	boolean	更新目录。