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

Справочник методов класса ApiPictureForm текстового документа

Обновлено: 15.12.25

new ApiPictureForm()

Класс, представляющий форму изображения документа.

Свойства

Название Тип Описание
scaleFlag ScaleFlag Условие масштабирования изображения на картинке: «всегда», «никогда», «слишком большое» или «слишком маленькое».
lockAspectRatio логический Указывает, заблокировано ли соотношение сторон формы изображения.
respectBorders логический Определяет, соблюдается или нет ширина границ формы при масштабировании изображения.
shiftX процентный Горизонтальное положение изображения внутри формы изображения, измеряемое в процентах:

  • 0 — изображение располагается слева;
  • 50 — изображение располагается в центре;
  • 100 — изображение располагается справа;
shiftY процентный Вертикальное положение изображения внутри формы изображения, измеряемое в процентах:

  • 0 — картинка располагается сверху;
  • 50 — изображение размещается в центре;
  • 100 -изображение располагается внизу.

Методы

Название Описание
Clear ↗ Очищает текущую форму.
Copy ↗ Копирует текущую форму (копирует вместе с формой, если она существует).
GetClassType ↗ Возвращает тип класса ApiFormBase.
GetFormKey ↗ Возвращает текущий ключ формы.
GetFormType ↗ Возвращает тип текущей формы.
GetImage ↗ Возвращает изображение в формате base64 из текущей формы изображения.
GetPicturePosition ↗ Возвращает позицию изображения внутри текущей формы.
GetScaleFlag ↗ Возвращает текущее состояние масштабирования формы изображения.
GetText ↗ Возвращает текст из текущей формы. Этот метод используется только для текстовых форм и форм с комбинированными формами.
GetTextPr ↗ Возвращает свойства текста из текущей формы. Этот метод используется только для текстовых форм и комбинированных списков.
GetTipText ↗ Возвращает текст подсказки текущей формы.
GetWrapperShape ↗ Возвращает форму, в которую помещается форма для управления положением и размером рамки формы фиксированного размера. Для встроенных форм будет возвращено нулевое значение.
IsFixed ↗ Проверяет, имеет ли текущая форма фиксированный размер.
IsLockAspectRatio ↗ Проверяет, заблокировано или нет соотношение сторон текущей формы изображения.
IsRequired ↗ Проверяет, требуется ли текущая форма.
IsRespectBorders ↗ Проверяет, соблюдается или нет ширина границы формы.
SetBackgroundColor ↗ Устанавливает цвет фона для текущей формы.
SetBorderColor ↗ Устанавливает цвет границы текущей формы.
SetFormKey ↗ Устанавливает ключ в текущую форму.
SetImage ↗ Устанавливает изображение в текущую форму изображения.
SetLockAspectRatio ↗ Фиксирует соотношение сторон текущего изображения.
SetPicturePosition ↗ Устанавливает положение изображения внутри текущей формы:

  • 0 — изображение располагается слева/сверху;
  • 50 -изображение располагается центре;
  • 100 — изображение располагается справа/снизу.
SetPlaceholderText ↗ Устанавливает плкейсхолдер в текущую форму. Не может быть установлен в флажок или переключатель.
SetRequired ↗ Указывает, должна ли текущая форма быть обязательной.
SetRespectBorders ↗ Соблюдает ширину границ формы при масштабировании изображения.
SetScaleFlag ↗ Устанавливает условие масштабирования для текущей формы изображения.
SetTextPr ↗ Устанавливает свойства текста в текущую форму. Этот метод используется только для текстовых форм и комбинированных списков.
SetTipText ↗ Устанавливает текст подсказки для текущей формы.
ToFixed ↗ Преобразует текущую форму в форму с фиксированным размером.
ToInline ↗ Преобразует текущую форму во встроенную форму. Форма изображения не может быть преобразована во встроенную форму, это всегда объект фиксированного размера.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oPictureForm = Api.CreatePictureForm({"key": "Personal information", "tip": "Upload your photo", "required": true, "placeholder": "Photo"});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oPictureForm);
oPictureForm.SetImage("https://TEST_URL/content/img/editor/opening.jpg");
oPictureForm.SetLockAspectRatio(true);
oPictureForm.SetScaleFlag("tooBig");
oPictureForm.SetPicturePosition(70, 70);
oPictureForm.SetRespectBorders(true);
var sScaleFlag = oPictureForm.GetScaleFlag();
var aPosition = oPictureForm.GetPicturePosition();
var bLock = oPictureForm.IsLockAspectRatio();
var bRespectBorders = oPictureForm.IsRespectBorders();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture scale flag: " + sScaleFlag);
oParagraph.AddLineBreak();
oParagraph.AddText("The aspect ratio of the first picture form in this document is locked: " + bLock);
oParagraph.AddLineBreak();
oParagraph.AddText("The borders of the first picture form in this document are respected when scaling the image: " + bRespectBorders);
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture position: ");
oParagraph.AddLineBreak();
for (let i = 0; i < aPosition.length; i++ ){
    var nShift = aPosition[i];
    oParagraph.AddText("" + nShift);
    oParagraph.AddLineBreak();
}
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiPictureForm.docx");
builder.CloseFile();