• Post category:ApiParagraph
  • Запись изменена:13.05.2023

AddCaption(sAdditional, [sLabel], [bExludeLabel], [sNumberingFormat], [bBefore], [nHeadingLvl], [sCaptionSep]) → { boolean }

Добавляет абзац заголовка после (или до) текущего абзаца.

Обратите внимание, что текущий абзац должен находиться в документе (а не в колонтитуле/шапке). А если текущий абзац помещается в фигуру, то подпись добавляется после (или перед) родительской фигурой.

Параметры:

Название Тип По умолчанию Описание
sAdditional строковый 0 Дополнительный текст.
sLabel CaptionLabel | строковый «Table» Ярлык заголовка.
bExludeLabel логически false Указывает, следует ли исключить метку из заголовка.
sNumberingFormat CaptionNumberingFormat «Arabic» Возможный формат нумерации подписей.
bBefore логически false Указывает, следует ли вставлять подпись перед текущим абзацем (true) или после (false) (после/перед фигурой, если она размещена в фигуре).
nHeadingLvl числовой null Уровень заголовка (используется, если вы хотите указать номер главы).

Если вы хотите указать «Заголовок 1», то nHeadingLvl === 0 и т.д.

sCaptionSep CaptionSep «hyphen» Разделитель заголовков (используется, если вы хотите указать номер главы).

Возвращает:

Логический тип.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateImage("url-image.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();