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();
[wbcr_css_snippet id="18802"][wbcr_css_snippet id="21788"]