Skip to main content

Combobox API overview

Methods#

NameDescription
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#

NameDescription
afterClosefires after closing a list with options
afterOpenfires after opening a list with options
beforeClosefires before closing a list with options
beforeOpenfires before opening a list with options
blurfires when Combobox has lost focus
changefires when a new option is selected
focusfires when Combobox has received focus
inputfires on typing text in an input of Combobox
keydown fires when any key is pressed and the element of Combobox is in focus
important

Use DataCollection events to work with data.

Properties#

NameDescription
cssadds style classes to Combobox
dataspecifies an array of data objects to set into the combobox
disabledmakes Combo Box disabled
filtersets a custom function for filtering Combo Box options
helpMessageadds an icon with a question mark next to the Combo input
hiddenLabeladds a hidden label for a Combo box input that will be used while sending a form to the server
itemHeightsets the height of an item in the list of options
itemsCountshows the total number of selected options
labeladds a label for ComboBox
labelPositiondefines the position of a label of a combobox
labelWidthsets the width of a label
listHeightsets the height of the list of options
multiselectionenables selection of multiple options in ComboBox
placeholdersets a placeholder in the input of Combo
readOnlymakes Combo Box readonly
selectAllButtondefines whether the Select All button should be shown
templatesets a template of displaying options in the popup list
valuespecifies the values that will appear in the input on initialization of the combobox
virtualenables dynamic loading of data on scrolling the list of options