AddTableOfContents

向当前文档添加目录。 💡 请注意，新目录将替换现有目录。

语法

expression.AddTableOfContents(oTocPr);

expression - 表示 ApiDocument 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
oTocPr	可选	TocPr	{}	目录属性。

返回值

boolean

示例

从文档中的标题生成目录。

// How do I build a table of contents based on heading styles in a document?

// Configure page numbers, leader dots, and outline depth when inserting a table of contents in a document.

let doc = Api.GetDocument();
let newDocumentStyle = doc.GetStyle("Heading 1");
let paragraph = doc.GetElement(0);
paragraph.SetStyle(newDocumentStyle);
paragraph.AddText("Heading 1");
newDocumentStyle = doc.GetStyle("Heading 2");
paragraph = Api.CreateParagraph();
paragraph.SetStyle(newDocumentStyle);
paragraph.AddText("Heading 2");
doc.Push(paragraph);
let tocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": {"OutlineLvls": 9}, "TocStyle": "standard"};
doc.AddTableOfContents(tocPr);