• Post category:ApiTextForm
  • Запись изменена:24.01.2024

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();