• Post category:ApiBlockLvlSdt
  • Запись изменена:02.08.2023

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

Добавляет абзац заголовка после (или до) текущего элемента управления содержимым.

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

Параметры:

НазваниеТипПо умолчаниюОписание
sAdditionalстроковыйДополнительный текст.
sLabelCaptionLabel | String«Table»Ярлык заголовка.
bExludeLabelлогическийfalseУказывает, следует ли исключить метку из заголовка.
sNumberingFormatCaptionNumberingFormat«Arabic»Возможный формат нумерации подписей.
bBeforeлогическийfalseУказывает, следует ли вставлять заголовок перед текущим элементом управления содержимым (true) или после (false) (после/перед фигурой, если она размещена в фигуре).
nHeadingLvlчисловойnullУровень заголовка (используется, если вы хотите указать номер главы).
Если вы хотите указать «Заголовок 1», то nHeadingLvl === 0 и т.д.
sCaptionSepCaptionSep«hyphen»Разделитель заголовков (используется, если вы хотите указать номер главы).

Возвращает:

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

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oBlockLvlSdt = Api.CreateBlockLvlSdt();
var oParagraph = Api.CreateParagraph();
var oDrawing = Api.CreateImage("test-url.png", 60 * 36000, 35 * 36000);
oParagraph.AddDrawing(oDrawing);
oBlockLvlSdt.AddElement(oParagraph, 0);
oDocument.AddElement(0, oBlockLvlSdt);
oBlockLvlSdt.AddCaption("", "Figure", false, "Arabic", false, undefined, "hyphen");
builder.SaveFile("docx", "AddCaption.docx");
builder.CloseFile();