• Post category:ApiFormBase
  • Запись изменена:09.12.2023

new ApiFormBase()

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

Характеристики

Название Тип Описание
key string Ключ формы.
tip string Подсказка формы (tip)
required boolean Указывает, является ли форма обязательной или нет.
placeholder string Текст плейсхолдра.

Методы

 

Название Описание
Clear Очищает текущую форму.
Copy Копирует текущую форму (копирует вместе с формой, если она существует).
GetClassType Возвращает тип класса ApiFormBase.
GetFormKey Возвращает текущий ключ формы.
GetFormType Возвращает тип текущей формы.
GetText Возвращает текст из текущей формы. Этот метод используется только для текстовых форм и комбинированных списков.
GetTextPr Возвращает свойства текста из текущей формы. Этот метод используется только для текстовых форм и комбинированными списков.
GetTipText Возвращает текст подсказки для текущей формы.
GetWrapperShape Возвращает фигуру, в которой размещена форма, для управления положением и размером рамки формы, обладающей фиксированным размером. Для встроенных форм будет возвращено нулевое значение.
IsFixed Проверяет, имеет ли текущая форма фиксированный размер.
IsRequired Проверяет, требуется ли текущая форма.
SetBackgroundColor Устанавливает цвет фона для текущей формы.
SetBorderColor Устанавливает цвет границы текущей формы.
SetFormKey Устанавливает ключ в текущую форму.
SetPlaceholderText Устанавливает плейсолдер в текущую форму. Переключатель и флажок не могут быть установлены.
SetRequired Указывает, требуется ли текущая форма.
SetTextPr Устанавливает свойства текста для текущей формы. Этот метод используется только для текстовых форм и комбинированных списков.
SetTipText Устанавливает текст подсказки в текущую форму.
ToFixed Преобразует текущую форму в форму с фиксированным размером.
ToInline Преобразует текущую форму во встроенную форму. Форма изображения не может быть преобразована во встроенную форму, так как это объект обладает фиксированным размером.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
oTextForm.SetBorderColor(255, 0, 0);
oTextForm.ToFixed(10 * 240, 2 * 240);
oTextForm.SetText("John Smith");
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(30);
oTextPr.SetBold(true);
oTextForm.SetTextPr(oTextPr);
var oFormTextPr = oTextForm.GetTextPr();
oFormTextPr.SetItalic(true);
var oShape = oTextForm.GetWrapperShape();
var oStroke = Api.CreateStroke(36000, Api.CreateSolidFill(Api.CreateRGBColor(255, 0, 0)));
oShape.SetOutLine(oStroke);
var oCopyForm = oTextForm.Copy();
oParagraph = Api.CreateParagraph();
oParagraph.AddElement(oCopyForm);
oDocument.Push(oParagraph);
oCopyForm.ToInline();
var sText = oTextForm.GetText();
var sClassType = oTextForm.GetClassType();
var sFormType = oTextForm.GetFormType();
var bFixed = oTextForm.IsFixed();
var bFixedCopy = oCopyForm.IsFixed();
var bRequired = oTextForm.IsRequired();
var sKey = oTextForm.GetFormKey();
var sTipText = oTextForm.GetTipText();
oCopyForm.SetText("John Smith");
oCopyForm.Clear();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class type: " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("Form type: " + sFormType);
oParagraph.AddLineBreak();
oParagraph.AddText("Form text: " + sText);
oParagraph.AddLineBreak();
oParagraph.AddText("The first form from this document has a fixed size: " + bFixed);
oParagraph.AddLineBreak();
oParagraph.AddText("The second form from this document has a fixed size: " + bFixedCopy);
oParagraph.AddLineBreak();
oParagraph.AddText("The first form from this document is required: " + bRequired);
oParagraph.AddLineBreak();
oParagraph.AddText("Form key: " + sKey);
oParagraph.AddLineBreak();
oParagraph.AddText("Form tip text: " + sTipText);
oParagraph.AddLineBreak();
oParagraph.AddText("The second form from this document was cleared.");
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiFormBase.docx");
builder.CloseFile();