Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы
Редакторы
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
Команда
Команда
Мобильные редакторы
Мобильные редакторы
Облачный офис
Облачный офис
Почта
Почта
Органайзер
Органайзер
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

AddCaptionCrossRef

Обновлено: 15.12.25

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

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

Параметры:

Название Тип По умолчанию Описание
sCaption CaptionLabel | string Ярлык заголовка («Уравнение», «Рисунок», «Таблица» или другой ярлык заголовка).
sRefType captionRefTo Текстовое или числовое значение ссылки на заголовок, которую вы хотите вставить.
oParaTo ApiParagraph Заголовок абзаца, на который делается ссылка (должен быть в документе).
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();