Blazor JqxComboBox API Reference

Name	Type
Properties
animationType	object
Sets the type of the animation. Possible Values: `'fade'` `'slide'` `'none'`
autoComplete	bool
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.
autoOpen	bool
Sets or gets whether the DropDown is automatically opened when the mouse cursor is moved over the widget.
autoItemsHeight	bool
Sets or gets whether items will wrap when they reach the width of the dropDown.
autoDropDownHeight	bool
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.
closeDelay	double
Sets the delay of the 'close' animation.
checkboxes	bool
Determines whether checkboxes will be displayed next to the list items.
disabled	bool
Enables/disables the jqxComboBox.
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.
dropDownHorizontalAlignment	object
Sets or gets the DropDown's alignment. Possible Values: `'left'` `'right'`
dropDownVerticalAlignment	object
Sets or gets the DropDown's alignment. Possible Values: `'top'` `'bottom'`
dropDownHeight	object
Sets or gets the height of the jqxComboBox's ListBox displayed in the widget's DropDown.
dropDownWidth	object
Sets or gets the width of the jqxComboBox's ListBox displayed in the widget's DropDown.
enableHover	bool
Enables/disables the hover state.
enableSelection	bool
Enables/disables the selection.
enableBrowserBoundsDetection	bool
Sets or gets whether the dropdown detects the browser window's bounds and automatically adjusts the dropdown's position.
height	object
Sets or gets the jqxComboBox height.
itemHeight	double
Sets or gets the height of the jqxComboBox Items. When the itemHeight == - 1, each item's height is equal to its desired height.
multiSelect	bool
Determines whether the jqxComboBox is in multi-select mode.
minLength	double
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.
openDelay	double
Sets or gets the delay of the 'open' animation.
popupZIndex	double
Sets or gets the popup's z-index.
placeHolder	string
Sets or gets the input field's place holder.
remoteAutoComplete	bool
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.
remoteAutoCompleteDelay	double
Determines the delay between two keystrokes. The search callback function is called on timeout. The value is specified in milliseconds.
renderer	object
Callback function which is called when an item is rendered. By using the renderer function, you can customize the look of the list items.
renderSelectedItem	object
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.
rtl	bool
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
selectedIndex	double
Sets or gets the selected index.
showArrow	bool
Determines whether the jqxComboBox shows its dropdown button.
showCloseButtons	bool
Determines whether the jqxComboBox shows the items close buttons in multi-select mode.
searchMode	object
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: `'none'` `'contains'` `'containsignorecase'` `'equals'` `'equalsignorecase'` `'startswithignorecase'` `'startswith'` `'endswithignorecase'` `'endswith'`
search	object
Callback function which is called when the 'remoteAutoComplate' property is set to true and the user types into the ComboBox's input field.
source	object
Sets or gets the items source.
scrollBarSize	object
Sets or gets the scrollbars size.
template	object
Determines the button's template as an alternative of the default styles. Possible Values: `'default' - the default template. The style depends only on the "theme" property value.` `'primary' - dark blue style for extra visual weight.` `'success' - green style for successful or positive action.` `'warning' - orange style which indicates caution.` `'danger' - red style which indicates a dangerous or negative action.` `'info' - blue button, not tied to a semantic action or use.`
theme	string
Sets the widget's theme. Include the theme's CSS file after jqx.base.css. The following code example adds the 'material' theme. `<link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../jqwidgets/styles/jqx.material.css" type="text/css" />` Set the widget's theme property to 'material' when you initialize it.
validateSelection	object
Determines whether an item can be selected in multi-select mode.
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.
width	object
Sets or gets the jqxComboBox's width.
Events
onBindingComplete	Event
This event is triggered when the data binding operation is completed.
onCheckChange	Event
This event is triggered when an item is checked/unchecked.
onClose	Event
This event is triggered when the popup ListBox is closed.
onChange	Event
This event is triggered when the user selects an item.
onOpen	Event
This event is triggered when the popup ListBox is opened.
onSelect	Event
This event is triggered when the user selects an item.
onUnselect	Event
This event is triggered when the user unselects an item.
Methods
Name	Arguments	Return Type
addItem	(object item)	bool
Adds a new item to the jqxComboBox. Returns 'true', if the new item is added or 'false' if the item is not added. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
clearSelection	()	void
Clears all selected items.
clear	()	void
Clears all items.
close	()	void
Hides the popup listbox.
checkIndex	(double index)	void
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.
checkItem	(object item)	void
Checks an item.
checkAll	()	void
Checks all list items when the 'checkboxes' property value is true.
destroy	()	void
Destroys the widget.
disableItem	(object item)	void
Disables an item. Item is an object. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
disableAt	(double index)	void
Disables an item by index. Index is a number.
enableItem	(object item)	void
Enables an item. Item is an object. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
enableAt	(double index)	void
Enables a disabled item by index. Index is a number.
ensureVisible	(double index)	void
Ensures that an item is visible. index is number. When necessary, the jqxComboBox scrolls to the item to make it visible.
focus	()	void
Sets the focus to the widget.
getItem	(double index)	object
Gets item by index. The returned value is an object with the following fields: label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getItemByValue	(string value)	object
Gets an item by its value. The returned value is an object with the following fields: label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getVisibleItems	()	object[]
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. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getItems	()	object[]
Gets all items. The returned value is an array of Items. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getCheckedItems	()	object[]
Gets the checked items. The returned value is an array of Items. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getSelectedItem	()	object
Gets the selected item. The returned value is an object or null(if there is no selected item). label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getSelectedItems	()	object[]
Gets the selected items when "multiselect" is turned on. The returned value is an Array with objects. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - gets the item's display html. This can be used instead of label. index - gets the item's index. group - gets the item's group.
getSelectedIndex	()	double
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.
insertAt	(object item, double index)	bool
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. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
isOpened	()	bool
Returns true, if the popup is opened. Otherwise returns false.
indeterminateIndex	(double index)	void
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.
indeterminateItem	(object item)	void
Indeterminates an item.
loadFromSelect	(string selectTagId)	void
Loads list items from a 'select' tag.
open	()	void
Shows the popup listbox.
removeItem	(object item)	bool
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.
removeAt	(double index)	bool
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.
selectIndex	(double index)	void
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.
selectItem	(object item)	void
Selects an item.
searchString	()	string

updateItem	(object item, string itemValue)	void
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. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
updateAt	(object item, object index)	void
Updates an item. The first parameter is the new item. The second parameter is the index of the item to be updated. label - determines the item's label. value - determines the item's value. disabled - determines whether the item is enabled/disabled. checked - determines whether item is checked/unchecked. hasThreeStates - determines whether the item's checkbox supports three states. html - determines the item's display html. This can be used instead of label. group - determines the item's group.
unselectIndex	(double index)	void
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.
unselectItem	(object item)	void
Unselects an item.
uncheckIndex	(double index)	void
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.
uncheckItem	(object item)	void
Unchecks an item.
uncheckAll	()	void
Unchecks all list items when the 'checkboxes' property value is true.
val	[SET] (string value) [GET] ()	[SET] void [GET] string
Sets or gets the selected value.

Properties

Events

Methods