Class representing a document combo box / dropdown list.
Name | Description |
Clear | Clears the current form. |
Copy | Copies the current form (copies with the shape if it exists). |
GetClassType | Returns a type of the ApiFormBase class. |
GetFormKey | Returns the current form key. |
GetFormType | Returns a type of the current form. |
GetListValues | Returns the list values from the current combo box. |
GetText | Returns the text from the current form. Returns the value as a string if possible for the given form type |
GetTextPr | Returns the text properties from the current form. Used if possible for this type of form |
GetTipText | Returns the tip text of the current form. |
GetWrapperShape | Returns a shape in which the form is placed to control the position and size of the fixed size form frame. The null value will be returned for the inline forms. |
IsEditable | Checks if the combo box text can be edited. If it is not editable, then this form is a dropdown list. |
IsFixed | Checks if the current form is fixed size. |
IsRequired | Checks if the current form is required. |
MoveCursorOutside | Places a cursor before/after the current form. |
SelectListValue | Selects the specified value from the combo box list values. |
SetBackgroundColor | Sets the background color to the current form. |
SetBorderColor | Sets the border color to the current form. |
SetFormKey | Sets a key to the current form. |
SetListValues | Sets the list values to the current combo box. |
SetPlaceholderText | Sets the placeholder text to the current form. Can't be set to checkbox or radio button. |
SetRequired | Specifies if the current form should be required. |
SetText | Sets the text to the current combo box. Available only for editable combo box forms. |
SetTextPr | Sets the text properties to the current form. Used if possible for this type of form |
SetTipText | Sets the tip text to the current form. |
ToFixed | Converts the current form to a fixed size form. |
ToInline | Converts the current form to an inline form. Picture form can't be converted to an inline form, it's always a fixed size object. |
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();