Combobox API overview
Methods
| Name | Description |
|---|---|
| addOption() | adds a new item into the list of Combobox options |
| blur() | removes focus from Combobox |
| clear() | clears the value set in the Combo Box |
| destructor() | removes a ComboBox instance and releases occupied resources |
| disable() | disables ComboBox on a page |
| enable() | enables a disabled ComboBox |
| focus() | sets focus in the input without opening a popup with options |
| getValue() | gets id(s) of items from data collection selected in ComboBox |
| isDisabled() | checks whether a combobox is disabled |
| paint() | repaints a Combo Box |
| setValue() | selects option(s) in ComboBox |
important
Use DataCollection methods to work with data.
Events
| Name | Description |
|---|---|
| afterClose | fires after closing a list with options |
| afterOpen | fires after opening a list with options |
| beforeChange | fires before selection of a new option |
| beforeClose | fires before closing a list with options |
| beforeOpen | fires before opening a list with options |
| blur | fires when Combobox has lost focus |
| change | fires when a new option is selected |
| focus | fires when Combobox has received focus |
| input | fires on typing text in an input of Combobox |
| keydown | fires when any key is pressed and an option of Combobox is in focus |
important
Use DataCollection events to work with data.
Properties
| Name | Description |
|---|---|
| css | Optional. Adds style classes to Combobox |
| data | Optional. Specifies an array of data objects to set into the combobox |
| disabled | Optional. Makes Combo Box disabled |
| filter | Optional. Sets a custom function for filtering Combo Box options |
| helpMessage | Optional. Adds an icon with a question mark next to the Combo input |
| hiddenLabel | Optional. Adds a hidden label for a Combo box input that will be used while sending a form to the server |
| htmlEnable | Optional. Enables/disables rendering of HTML content (inner HTML) in Combobox options |
| itemHeight | Optional. Sets the height of an item in the list of options |
| itemsCount | Optional. Shows the total number of selected options |
| label | Optional. Adds a label for ComboBox |
| labelPosition | Optional. Defines the position of a label of a combobox |
| labelWidth | Optional. Sets the width of a label |
| listHeight | Optional. Sets the height of the list of options |
| multiselection | Optional. Enables selection of multiple options in ComboBox |
| newOptions | Optional. Allows end users to add new options into the data collection of Combobox |
| placeholder | Optional. Sets a placeholder in the input of Combo |
| readOnly | Optional. Makes Combo Box readonly |
| selectAllButton | Optional. Defines whether the Select All button should be shown |
| template | Optional. Sets a template of displaying options in the popup list |
| value | Optional. Specifies the values that will appear in the input on initialization of the combobox by their id(s) |
| virtual | Optional. Enables dynamic loading of data on scrolling the list of options |