new ApiPictureForm()

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

Свойства

НазваниеТипОписание
scaleFlagScaleFlagУсловие масштабирования изображения на картинке: «всегда», «никогда», «слишком большое» или «слишком маленькое».
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://api.onlyoffice.com/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();