GetIncludeLabel

返回图表目录条目中是否包含题注标签和编号。

备注

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

语法

expression.GetIncludeLabel();

expression - 表示 ApiTableOfFigures 类的变量。

参数

此方法没有任何参数。

返回值

boolean

示例

检查图表目录是否包含题注标签和编号。

// Add a captioned figure and a table of figures built from the "Figure" label.

// Read whether the caption label and number are shown in the table of figures entries.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("Figure 1");
paragraph.AddCaption(" - Sample figure", "Figure", false, "Arabic", false, undefined, "hyphen");
let tof = doc.AddTableOfFigures({"BuildFrom": "Figure", "LabelNumber": true});
let isIncludeLabel = tof.GetIncludeLabel();
let resultParagraph = Api.CreateParagraph();
resultParagraph.AddText("Caption label included: " + isIncludeLabel);
doc.Push(resultParagraph);