AddCaption
function AddCaption(
sAdditional: string = null,
sLabel: CaptionLabel | String = "Table",
bExludeLabel: boolean = false,
sNumberingFormat: CaptionNumberingFormat = "Arabic",
bBefore: boolean = false,
nHeadingLvl: Number = null,
sCaptionSep: CaptionSep = "hyphen",
): booleanDescription
Adds a caption paragraph after (or before) the current table. Please note that the current table must be in the document (not in the footer/header). And if the current table is placed in a shape, then a caption is added after (or before) the parent shape.
Parameters
- sAdditional
stringdefault: null The additional text.
The caption label.
- bExludeLabel
booleandefault: false Specifies whether to exclude the label from the caption.
The possible caption numbering format.
- bBefore
booleandefault: false Specifies whether to insert the caption before the current table (true) or after (false) (after/before the shape if it is placed in the shape).
- nHeadingLvl
Numberdefault: null The heading level (used if you want to specify the chapter number).
If you want to specify "Heading 1", then nHeadingLvl === 0 and etc. The caption separator (used if you want to specify the chapter number).
Returns
booleanTry It
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is just a sample text in the first cell.");
var oCell = oTable.GetCell(0,0);
oTable.AddElement(oCell, 0, oParagraph);
oTable.AddCaption("", "Table", false, "Arabic", false, undefined, "hyphen");