Name | Type | Default | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
animationType | String | 'slide' | |||||||||
Sets the type of the animation. Possible Values:
Code example
Set the
Get the
Try it: animationType is set to 'fade'
|
|||||||||||
autoComplete | Boolean | false | |||||||||
Sets or gets the whether the 'autoComplete' feature is enabled or disabled. When this feature is enabled, the jqxComboBox displays in the popup listbox, only the items that match the searched text. Code example
Set the
Get the
Try it: autoComplete is set to true
|
|||||||||||
autoOpen | Boolean | false | |||||||||
Sets or gets whether the DropDown is automatically opened when the mouse cursor is moved over the widget. Code example
Set the
Get the
Try it: autoOpen is set to true
|
|||||||||||
autoItemsHeight | Boolean | false | |||||||||
Sets or gets whether items will wrap when they reach the width of the dropDown. Code example
Set the
Get the
Try it: autoItemsHeight is set to true
|
|||||||||||
autoDropDownHeight | Boolean | false | |||||||||
Sets or gets whether the height of the jqxComboBox's ListBox displayed in the widget's DropDown is calculated as a sum of the items heights. Code example
Set the
Get the
|
|||||||||||
closeDelay | Number | 400 | |||||||||
Sets the delay of the 'close' animation. Code example
Set the
Get the
Try it: closeDelay is set to 2000
|
|||||||||||
checkboxes | Boolean | false | |||||||||
Determines whether checkboxes will be displayed next to the list items. (The feature requires jqxcheckbox.js) Code example
Set the
Get the
Try it: checkboxes is set to true
|
|||||||||||
disabled | Boolean | false | |||||||||
Enables/disables the jqxComboBox. Code example
Set the
Get the
Try it: disabled is set to true
|
|||||||||||
displayMember | String | "" | |||||||||
Sets or gets the displayMember of the Items. The displayMember specifies the name of an object property to display. The name is contained in the collection specified by the 'source' property. Code example
Set the
Get the
Try it: displayMember is set to "text"
|
|||||||||||
dropDownHorizontalAlignment | String | 'left' | |||||||||
Sets or gets the DropDown's alignment. Possible Values:
Code example
Get the
|
|||||||||||
dropDownVerticalAlignment | String | 'bottom' | |||||||||
Sets or gets the DropDown's alignment. Possible Values:
Code example
Get the
|
|||||||||||
dropDownHeight | Number | 200 | |||||||||
Sets or gets the height of the jqxComboBox's ListBox displayed in the widget's DropDown. Code example
Set the
Get the
Try it: dropDownHeight is set to "300px"
|
|||||||||||
dropDownWidth | Number | 200 | |||||||||
Sets or gets the width of the jqxComboBox's ListBox displayed in the widget's DropDown. Code example
Set the
Get the
Try it: dropDownWidth is set to "300px"
|
|||||||||||
enableHover | Boolean | true | |||||||||
Enables/disables the hover state. Code example
Set the
Get the
Try it: enableHover is set to false
|
|||||||||||
enableSelection | Boolean | true | |||||||||
Enables/disables the selection. Code example
Set the
Get the
Try it: enableSelection is set to false
|
|||||||||||
enableBrowserBoundsDetection | Boolean | false | |||||||||
Sets or gets whether the dropdown detects the browser window's bounds and automatically adjusts the dropdown's position. Code example
Set the
Get the
|
|||||||||||
height | Number/String | null | |||||||||
Sets or gets the jqxComboBox height. Code example
Set the
Get the
Try it: height is set to '25px'
|
|||||||||||
itemHeight | Number | -1 | |||||||||
Sets or gets the height of the jqxComboBox Items. When the itemHeight == - 1, each item's height is equal to its desired height. Code example
Set with the
Get the
Try it: itemHeight is set to 25
|
|||||||||||
multiSelect | Boolean | false | |||||||||
Determines whether the jqxComboBox is in multi-select mode. Code example
Set the
Get the
Try it: multiSelect is set to true
|
|||||||||||
minLength | Number | 2 | |||||||||
Determines the minimum number of characters that need to be entered by the user for search in remote data source when remoteAutoComplete property is set to true. Code example
Set the
Get the
Try it: minLength is set to 2
|
|||||||||||
openDelay | Number | 350 | |||||||||
Sets or gets the delay of the 'open' animation. Code example
Set the
Get the
Try it: openDelay is set to 2000
|
|||||||||||
popupZIndex | Number | 20000 | |||||||||
Sets or gets the popup's z-index. Code example
Set the
Get the
Try it: popupZIndex is set to 999
|
|||||||||||
placeHolder | String | "" | |||||||||
Sets or gets the input field's place holder. Code example
Set the
Get the
|
|||||||||||
remoteAutoComplete | Boolean | false | |||||||||
Determines whether the items displayed in the popup come from a remote data source. When this property is set to true, the jqxComboBox calls the 'search' callback function when the user types into the input field. Code example
Set the
Get the
|
|||||||||||
remoteAutoCompleteDelay | Number | 300 | |||||||||
Determines the delay between two keystrokes. The search callback function is called on timeout. The value is specified in milliseconds. Code example
Set the
Get the
|
|||||||||||
renderer | function | null | |||||||||
Callback function which is called when an item is rendered. By using the renderer function, you can customize the look of the list items. Code example
Set the
Get the
|
|||||||||||
renderSelectedItem | function | null | |||||||||
Callback function which is called when the selected item is rendered. By using the renderSelectedItem function, you can customize the displayed text in the ComboBox's input field. Code example
Set the
Get the
|
|||||||||||
rtl | Boolean | false | |||||||||
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts. Code example
Set the
Get the
Try it: rtl is set to true
|
|||||||||||
selectedIndex | Number | -1 | |||||||||
Sets or gets the selected index. Code example
Set the
Get the
Try it: selectedIndex is set to 2
|
|||||||||||
showArrow | Boolean | true | |||||||||
Determines whether the jqxComboBox shows its dropdown button. Code example
Set the
Get the
Try it: showArrow is set to false
|
|||||||||||
showCloseButtons | Boolean | true | |||||||||
Determines whether the jqxComboBox shows the items close buttons in multi-select mode. Code example
Set the
Get the
Try it: showCloseButtons is set to false
|
|||||||||||
searchMode | String | startswith | |||||||||
Sets or gets the item search mode. When the user types into the edit field, the jqxComboBox widget tries to find the searched item using the entered text and the selected search mode. Possible Values:
Code example
Set the
Get the
Try it: searchMode is set to 'endswith'
|
|||||||||||
search | function | null | |||||||||
Callback function which is called when the 'remoteAutoComplate' property is set to true and the user types into the ComboBox's input field. Code example
Set the
Get the
|
|||||||||||
source | Array | null | |||||||||
Sets or gets the items source. Code example
Set a jqxComboBox with the
Binding using the jqx.dataAdapter(requires jqxdata.js):
Get the
Try it: source is set to dataAdapter
|
|||||||||||
scrollBarSize | Number | 17 | |||||||||
Sets or gets the scrollbars size. Code example
Set the
Get the
Try it: scrollBarSize is set to 10
|
|||||||||||
template | String | 'default' | |||||||||
Determines the button's template as an alternative of the default styles. Possible Values:
Code examples
Set the
Get the
Try it: template is set to 'success'
|
|||||||||||
theme | String | '' | |||||||||
Sets the widget's theme. jQWidgets uses a pair of css files - jqx.base.css and jqx.[theme name].css. The base stylesheet creates the styles related to the widget's layout like margin, padding, border-width, position. The second css file applies the widget's colors and backgrounds. The jqx.base.css should be included before the second CSS file. In order to set a theme, you need to do the following:
Try it: theme is set to 'energyblue'
|
|||||||||||
validateSelection | Function | null | |||||||||
Determines whether an item can be selected in multi-select mode. Code example
Set the
Get the
|
|||||||||||
valueMember | String | "" | |||||||||
Sets or gets the valueMember of the Items. The valueMember specifies the name of an object property to set as a 'value' of the list items. The name is contained in the collection specified by the 'source' property. Code example
Set the
Get the
Try it: valueMember is set to "value"
|
|||||||||||
width | Number/String | null | |||||||||
Sets or gets the jqxComboBox's width. Code example
Set the
Get the
Try it: width is set to '200px'
|
|||||||||||
Events |
|||||||||||
bindingComplete | Event | ||||||||||
This event is triggered when the data binding operation is completed. Code example
Bind to the
|
|||||||||||
checkChange | Event | ||||||||||
This event is triggered when an item is checked/unchecked. Code example
Bind to the
The item object has the following fields:
|
|||||||||||
close | Event | ||||||||||
This event is triggered when the popup ListBox is closed. Code example
Bind to the
|
|||||||||||
change | Event | ||||||||||
This event is triggered when the user selects an item. Code example
Bind to the
The item object has the following fields:
|
|||||||||||
open | Event | ||||||||||
This event is triggered when the popup ListBox is opened. Code example
Bind to the
|
|||||||||||
select | Event | ||||||||||
This event is triggered when the user selects an item. Code example
Bind to the
The item object has the following fields:
|
|||||||||||
unselect | Event | ||||||||||
This event is triggered when the user unselects an item. Code example
Bind to the
The item object has the following fields:
|
|||||||||||
Methods |
|||||||||||
addItem | Method | ||||||||||
Adds a new item to the jqxComboBox. Returns 'true', if the new item is added or 'false' if the item is not added. The following fields can be used for the new item:
None Code example
Invoke the
Code example 2
Invoke the
Try it: adds an item in the jqxComboBox
|
|||||||||||
clear | Method | ||||||||||
Clears all items.
None Code example
Invoke the
|
|||||||||||
clearSelection | Method | ||||||||||
Clears all selected items.
None Code example
Invoke the
|
|||||||||||
clear | Method | ||||||||||
Clears all items.
None Code example
Invoke the
|
|||||||||||
close | Method | ||||||||||
Hides the popup listbox.
None Code example
Invoke the
Try it: closes jqxComboBox
|
|||||||||||
checkIndex | Method | ||||||||||
Checks a list item when the 'checkboxes' property value is true. The index is zero-based, i.e to check the first item, the 'checkIndex' method should be called with parameter 0.
None Code example
Invoke the
Try it: checks a box in the jqxComboBox
|
|||||||||||
checkItem | Method | ||||||||||
Checks an item.
None Code example
Invoke the c
*To get an item, use the getItem or getItemByValue methods. |
|||||||||||
checkAll | Method | ||||||||||
Checks all list items when the 'checkboxes' property value is true.
None Code example
Invoke the
|
|||||||||||
destroy | Method | ||||||||||
Destroys the widget.
None Code examples
Invoke the
Try it: destroys the jqxComboBox
|
|||||||||||
disableItem | Method | ||||||||||
Disables an item. Item is an Object. The following fields can be used for the item:
None Code example
Invoke the
|
|||||||||||
disableAt | Method | ||||||||||
Disables an item by index. Index is a number.
None Code example
Invoke the
|
|||||||||||
enableItem | Method | ||||||||||
Enables an item. Item is an Object. The following fields can be used for the item:
None Code example
Invoke the
|
|||||||||||
enableAt | Method | ||||||||||
Enables a disabled item by index. Index is a number.
None Code example
Invoke the
|
|||||||||||
ensureVisible | Method | ||||||||||
Ensures that an item is visible. index is number. When necessary, the jqxComboBox scrolls to the item to make it visible.
None Code example
Invoke the
|
|||||||||||
focus | Method | ||||||||||
Sets the focus to the widget.
None Code example
Invoke the
Try it: focuses the jqxComboBox
|
|||||||||||
getItem | Method | ||||||||||
Gets item by index. The returned value is an Object with the following fields: Item Fields
Object Code example
Invoke the
|
|||||||||||
getItemByValue | Method | ||||||||||
Gets an item by its value. The returned value is an Object with the following fields:
Object Code example
Invoke the
|
|||||||||||
getVisibleItems | Method | ||||||||||
Gets all items displayed in the ComboBox. The method could be useful for getting the currently visible items after auto complete. The returned value is an array of Items. Each item represents an Object with the following fields.Item Fields
Array Code example
Invoke the
Get the first item.
|
|||||||||||
getItems | Method | ||||||||||
Gets all items. The returned value is an array of Items. Each item represents an Object with the following fields.Item Fields
Array Code example
Invoke the
Get the first item.
|
|||||||||||
getCheckedItems | Method | ||||||||||
Gets the checked items. The returned value is an array of Items. Each item represents an Object with the following fields.Item Fields
Array Code example
Invoke the
|
|||||||||||
getSelectedItem | Method | ||||||||||
Gets the selected item. The returned value is an Object or null(if there is no selected item). Item Fields
Object Code example
Invoke the
|
|||||||||||
getSelectedItems | Method | ||||||||||
Gets the selected items when "multiselect" is turned on. The returned value is an Array with Objects. Each object has the following fields
Array Code example
Invoke the
Try it: returns the selected items
|
|||||||||||
getSelectedIndex | Method | ||||||||||
Gets the index of the selected item. The returned value is the index of the selected item. If there's no selected item, -1 is returned.
Number Code example
Invoke the
|
|||||||||||
insertAt | Method | ||||||||||
Inserts a new item to the jqxComboBox. Returns 'true', if the new item is inserted or false if the insertaion fails. The first parameter is Object or String - the new item. The second parameter is Number - the item's index. The following fields can be used for the new item:
None Code example
Invoke the
Code example 2
Invoke the
|
|||||||||||
isOpened | Method | ||||||||||
Returns true, if the popup is opened. Otherwise returns false.
Boolean Code example
Invoke the
|
|||||||||||
indeterminateIndex | Method | ||||||||||
Indeterminates a list item when the 'checkboxes' property value is true. The index is zero-based, i.e to indeterminate the first item, the 'indeterminateIndex' method should be called with parameter 0.
None Code example
Invoke the
|
|||||||||||
indeterminateItem | Method | ||||||||||
Indeterminates an item.
None Code example
Invoke the
*To get an item, use the getItem or getItemByValue methods. |
|||||||||||
loadFromSelect | Method | ||||||||||
Loads list items from a 'select' tag.
None Code example
Invoke the
'select' is the id of a select tag. Code Example: <select style='height: 25px; width: 200px; margin-left: 30px;' id='select'> |
|||||||||||
open | Method | ||||||||||
Shows the popup listbox.
None Code example
Invoke the
Try it: opens jqxComboBox
|
|||||||||||
removeItem | Method | ||||||||||
Removes an item from the listbox. Parameter type: Object returned by the "getItem" method or String - the value of an item. Returns 'true', if the item is removed or 'false', if the item is not removed.
None Code example
Invoke the
|
|||||||||||
removeAt | Method | ||||||||||
Removes an item from the listbox. Parameter type: Number - the index of the item. The method returns 'true', if the item is removed or 'false', if the item is not removed.
None Code example
Invoke the
|
|||||||||||
selectIndex | Method | ||||||||||
Selects an item by index. The index is zero-based, i.e to select the first item, the 'selectIndex' method should be called with parameter 0.
None Code example
Invoke the
|
|||||||||||
selectItem | Method | ||||||||||
Selects an item.
None Code example
Invoke the
*To get an item, use the getItem or getItemByValue methods.
|
|||||||||||
updateItem | Method | ||||||||||
Updates an item. The first parameter is the new item. The second parameter could be an existing item or the value of an existing item. The following fields can be used for the item:
None Code example
Invoke the
|
|||||||||||
updateAt | Method | ||||||||||
Updates an item. The first parameter is the new item. The second parameter is the index of the item to be updated. The following fields can be used for the item:
None Code example
Invoke the
|
|||||||||||
unselectIndex | Method | ||||||||||
Unselects item by index. The index is zero-based, i.e to unselect the first item, the 'unselectIndex' method should be called with parameter 0.
None Code example
Invoke the
|
|||||||||||
unselectItem | Method | ||||||||||
Unselects an item.
None Code example
Invoke the
*To get an item, use the getItem or getItemByValue methods.
|
|||||||||||
uncheckIndex | Method | ||||||||||
Unchecks a list item when the 'checkboxes' property value is true. The index is zero-based, i.e to uncheck the first item, the 'uncheckIndex' method should be called with parameter 0.
None Code example
Invoke the
|
|||||||||||
uncheckItem | Method | ||||||||||
Unchecks an item.
None Code example
Invoke the
*To get an item, use the getItem or getItemByValue methods. |
|||||||||||
uncheckAll | Method | ||||||||||
Unchecks all list items when the 'checkboxes' property value is true.
None Code example
Invoke the
|
|||||||||||
val | Method | ||||||||||
Sets or gets the selected value.
String Code example
Invoke the
// Get the value using jQuery's val()
// Set value.
// Set value using jQuery's val().
|