ApiTextForm

new ApiTextForm()

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

Настройки

НазваниеТипОписание
combлогическийУказывает, должно ли текстовое поле представлять собой набор символов с одинаковой шириной ячейки. Максимальное количество символов должно быть установлено на положительное значение.
maxCharactersчисловойМаксимальное количество символов в текстовом поле.
cellWidthчисловойШирина ячейки для каждого символа измеряется в миллиметрах. Если этот параметр не указан или равен 0 или меньше, то ширина будет установлена автоматически.
multiLineлогическийУказывает, является ли текущее текстовое поле фиксированного размера многострочным или нет.
autoFitлогическийУказывает, должно ли содержимое текстового поля подгоняться автоматически, т. е. подстраивается ли размер шрифта под размер формы фиксированного размера.

Методы

НазваниеОписание
ClearОчищает текущую форму.
CopyКопирует текущую форму (копирует фигуру, если она существует).
GetCharactersLimitВозвращает ограничение на количество символов текстового поля.
GetClassTypeВозвращает тип класса ApiFormBase.
GetFormKeyВозвращает текущий ключ формы.
GetFormTypeВозвращает тип текущей формы.
GetTextВозвращает текст из текущей формы. Этот метод используется только для текстовых форм и полей со списком.
GetTextPrВозвращает свойства текста из текущей формы. Этот метод используется только для текстовых форм и полей со списком.
GetTipTextВозвращает текст подсказки текущей формы.
GetWrapperShapeВозвращает фигуру, в которую помещается форма, для управления положением и размером рамки формы фиксированного размера. Для встроенных форм будет возвращено нулевое значение.
IsAutoFitПроверяет, соответствует ли содержимое текстового поля автоподбору, т. е. подстраивается ли размер шрифта под размер формы фиксированного размера.
IsCombПроверяет, представляет ли текстовое поле набор символов с одинаковой шириной ячейки.
IsFixedПроверяет, имеет ли текущая форма фиксированный размер.
IsMultilineПроверяет, является ли текущее текстовое поле многострочным.
IsRequiredПроверяет, требуется ли текущая форма.
SetAutoFitУказывает, должно ли содержимое текстового поля подгоняться автоматически, т. е. подстраивается ли размер шрифта под размер формы фиксированного размера.
SetBackgroundColorУстанавливает цвет фона текущей формы.
SetBorderColorУстанавливает цвет границы текущей формы.
SetCellWidthУстанавливает ширину ячейки в соответствии с примененной гребенкой символов.
SetCharactersLimitУстанавливает ограничение на количество символов текстового поля.
SetCombУказывает, должно ли текстовое поле представлять собой набор символов с одинаковой шириной ячейки. Максимальное количество символов должно быть установлено на положительное значение.
SetFormKeyУстанавливает ключ к текущей форме.
SetMultilineУказывает, должно ли текущее текстовое поле быть многострочным.
SetPlaceholderTextУстанавливает текст заполнителя в текущую форму. Невозможно установить флажок или переключатель.
SetRequiredУказывает, требуется ли текущая форма.
SetTextУстанавливает текст в текущее текстовое поле.
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", "multiLine": false, "autoFit": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
oTextForm.SetCharactersLimit(5);
oTextForm.SetText("John Smith");
oTextForm.SetComb(true);
var nLimit = oTextForm.GetCharactersLimit();
var bComb = oTextForm.IsComb();
var bMultiline = oTextForm.IsMultiline();
var bAutoFit = oTextForm.IsAutoFit();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Characters limit: " + nLimit);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is comb: " + bComb);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is multiline: " + bMultiline);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is autofit: " + bAutoFit);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiTextForm.docx");
builder.CloseFile();