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

new ApiFormBase()

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

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

НазваниеТипОписание
keystringКлюч формы.
tipstringПодсказка формы (tip)
requiredbooleanУказывает, является ли форма обязательной или нет.
placeholderstringТекст плейсхолдра.

Методы

 

НазваниеОписание
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();