AddCaption

在当前表格之后（或之前）添加题注段落。 💡 请注意，当前表格必须在文档中（不在页脚/页眉中）。 如果当前表格位于形状中，则题注将添加到父形状之后（或之前）。

语法

expression.AddCaption(sAdditional, sLabel, bExludeLabel, sNumberingFormat, bBefore, nHeadingLvl, sCaptionSep);

expression - 表示 ApiTable 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
sAdditional	必需	string		附加文本。
sLabel	可选	CaptionLabel | String	"Table"	题注标签。
bExludeLabel	可选	boolean	false	指定是否从题注中排除标签。
sNumberingFormat	可选	CaptionNumberingFormat	"Arabic"	可能的题注编号格式。
bBefore	可选	boolean	false	指定是在当前表格之前（true）还是之后（false）插入题注（如果位于形状中，则在形状之前/之后）。
nHeadingLvl	可选	Number		标题级别（用于指定章节编号时使用）。💡 如果要指定 "Heading 1"，则 nHeadingLvl === 0，依此类推。
sCaptionSep	可选	CaptionSep	"hyphen"	题注分隔符（如果要指定章节号时使用）。

返回值

boolean

示例

在文档中表格下方插入标记的题注以标识它。

// How do I add a numbered caption beneath a table so readers can reference it in a document?

// Attach a descriptive label with a sequence number to a table in a document.

let doc = Api.GetDocument();
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
table.SetStyle(tableStyle);
doc.Push(table);
let paragraph = Api.CreateParagraph();
paragraph.AddText("This is just a sample text in the first cell.");
let cell = table.GetCell(0, 0);
table.AddElement(cell, 0, paragraph);
table.AddCaption("", "Table", false, "Arabic", false, undefined, "hyphen");