AddCaption
Adds a caption paragraph after (or before) the current paragraph.
Please note that the current paragraph must be in the document (not in the footer/header).
And if the current paragraph is placed in a shape, then a caption is added after (or before) the parent shape.
Parameters:
| Name |
Type |
Default |
Description |
| sAdditional |
string
|
|
The additional text. |
| sLabel |
CaptionLabel | String
|
"Table" |
The caption label. |
| bExludeLabel |
boolean
|
false |
Specifies whether to exclude the label from the caption. |
| sNumberingFormat |
CaptionNumberingFormat
|
"Arabic" |
The possible caption numbering format. |
| bBefore |
boolean
|
false |
Specifies whether to insert the caption before the current paragraph (true) or after (false) (after/before the shape if it is placed in the shape). |
| nHeadingLvl |
Number
|
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. |
| sCaptionSep |
CaptionSep
|
"hyphen" |
The caption separator (used if you want to specify the chapter number). |
Returns:
- Type
-
boolean
Example
Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateImage("https://api.onlyoffice.com/content/img/docbuilder/examples/coordinate_aspects.png", 60 * 36000, 35 * 36000);
oParagraph.AddDrawing(oDrawing);
oParagraph = Api.CreateParagraph();
oDocument.Push(oParagraph);
oParagraph.AddCaption("", "Figure", false, "Arabic", false, undefined, "hyphen");
builder.SaveFile("docx", "AddCaption.docx");
builder.CloseFile();
Resulting document