ApiComboBoxForm

new ApiComboBoxForm()

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

Свойства

НазваниеТипОписание
editableлогическийУказывает, можно ли редактировать текст комбинированного окна.
autoFitлогическийОпределяет, должно ли содержимое формы комбобокса автоподстраиваться, т.е. подстраивается ли размер шрифта под размер формы фиксированного размера.
itemsМассив.<(string|Array.)>Элементы комбинированного окна. Этот массив состоит из строк или массивов из двух строк, где первая строка — отображаемое значение, а вторая — его смысл. Если массив состоит из одних строк, то отображаемое значение и его смысл одинаковы. Пример: [«Первый», [«Второй», «2»], [«Третий», «3»], «Четвертый»].

Методы

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

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oComboBoxForm = Api.CreateComboBoxForm({"key": "Personal information", "tip": "Choose your country", "required": true, "placeholder": "Country", "editable": true, "autoFit": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oComboBoxForm);
oComboBoxForm.SetListValues(["Latvia", "USA", "UK"]);
oComboBoxForm.SetText("France");
oComboBoxForm.SelectListValue("USA");
var aListValues = oComboBoxForm.GetListValues();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Combo box list values: ");
oParagraph.AddLineBreak();
for (let i = 0; i < aListValues.length; i++ ){
    oParagraph.AddText(aListValues[i]);
    oParagraph.AddLineBreak();
}
var bEdit = oComboBoxForm.IsEditable();
oParagraph.AddLineBreak();
oParagraph.AddText("The first combo box from this document is editable: " + bEdit);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiComboBoxForm.docx");
builder.CloseFile();