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

AddCaptionCrossRef(sCaption, sRefType, oParaTo, [bLink], [bAboveBelow]) → { boolean }

Добавляет перекрестную ссылку подписи к текущему абзацу. Абзац должен быть в документе.

Параметры:

НазваниеТипПо умолчаниюОписание
sCaptionCaptionLabel | stringЯрлык заголовка («Уравнение», «Рисунок», «Таблица» или другой ярлык заголовка).
sRefTypecaptionRefToТекстовое или числовое значение ссылки на заголовок, которую вы хотите вставить.
oParaToApiParagraphЗаголовок абзаца, на который делается ссылка (должен быть в документе).
bLinkлогическийtrueУказывает, будет ли ссылка вставлена как гиперссылка.
bAboveBelowлогическийfalseУказывает, следует ли включать слова выше/ниже, указывающие на позицию ссылки (используется только с sRefType «pageNum»).

Возвращает:

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

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateImage("url-image", 60 * 36000, 35 * 36000);
oParagraph.AddDrawing(oDrawing);
oParagraph = Api.CreateParagraph();
oDocument.Push(oParagraph);
oParagraph.AddCaption("", "Figure", false, "Arabic", false, undefined, "hyphen");
oParagraph = Api.CreateParagraph();
oDocument.Push(oParagraph);
oParagraph.AddText('Link to ');
var aCaptionParagraphs = oDocument.GetAllCaptionParagraphs("Figure");
oParagraph.AddCaptionCrossRef("Figure", "entireCaption", aCaptionParagraphs[0], true, false);
builder.SaveFile("docx", "AddCaptionCrossRef.docx");
builder.CloseFile();