|
Name |
Type |
autoOpen
|
bool
|
Sets or gets whether the DropDown is automatically opened when the mouse cursor is moved over the widget.
|
autoDropDownHeight
|
bool
|
Sets or gets whether the height of the jqxDropDownList's ListBox displayed in the widget's DropDown is calculated as a sum of the items heights.
|
animationType
|
object
|
Sets or gets the type of the animation.
Possible Values:
'fade'
'slide'
'none'
|
checkboxes
|
bool
|
Determines whether checkboxes will be displayed next to the list items.
|
closeDelay
|
double
|
Sets or gets the delay of the 'close' animation.
|
disabled
|
bool
|
Enables/disables the jqxDropDownList.
|
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 jqxDropDownList's ListBox displayed in the widget's DropDown.
|
dropDownWidth
|
object
|
Sets or gets the width of the jqxDropDownList's ListBox displayed in the widget's DropDown.
|
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.
|
enableHover
|
bool
|
Enables/disables the hover state.
|
filterable
|
bool
|
Determines whether the Filtering is enabled.
|
filterHeight
|
double
|
Determines the Filter's height.
|
filterDelay
|
double
|
Determines the Filter's delay. After 100 milliseconds, the widget automatically filters its data based on the filter input's value. To perform filter only on "Enter" key press, set this property to 0.
|
filterPlaceHolder
|
string
|
Determines the Filter input's place holder.
|
height
|
object
|
Sets or gets the jqxDropDownList's height.
|
incrementalSearch
|
bool
|
Sets or gets the incrementalSearch property. An incremental search begins searching as soon as you type the first character of the search string. As you type in the search string, jqxDropDownList automatically selects the found item. Focus the widget and start typing.
|
incrementalSearchDelay
|
double
|
Sets or gets the incrementalSearchDelay property. The incrementalSearchDelay specifies the time-interval in milliseconds after which the previous search string is deleted. The timer starts when you stop typing. Focus the widget and start typing.
|
itemHeight
|
double
|
Sets or gets the height of the jqxDropDownList Items. When the itemHeight == - 1, each item's height is equal to its desired height.
|
openDelay
|
double
|
Sets or gets the delay of the 'open' animation.
|
placeHolder
|
string
|
Text displayed when the selection is empty.
|
popupZIndex
|
double
|
Sets or gets the popup's z-index.
|
rtl
|
bool
|
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
|
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.
|
selectionRenderer
|
object
|
Callback function which is called when the selected item is rendered in the jqxDropDownList's content area. By using the selectionRenderer function, you can customize the look of the selected item.
|
searchMode
|
object
|
Sets or gets the item incremental search mode. When the user types some text in a focused DropDownList, the jqxListBox 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'
|
source
|
object[]
|
Sets or gets the items source.
|
selectedIndex
|
double
|
Sets or gets the selected index.
|
theme
|
string
|
Sets the widget's theme. Include the desired theme CSS file after 'jqx.base.css' file.
|
template
|
string
|
|
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 jqxDropDownList's width.
|
|
onBindingComplete
|
Event
|
This event is triggered when the data binding operation is completed.
|
onClose
|
Event
|
This event is triggered when the popup ListBox is closed.
|
onCheckChange
|
Event
|
This event is triggered when an item is checked/unchecked.
|
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.
|
|
Name |
Arguments |
Return Type |
addItem
|
(object item)
|
bool
|
Adds a new item to the jqxDropDownList. 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
|
|
close
|
()
|
void
|
|
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
|
|
checkAll
|
()
|
void
|
Checks all list items when the 'checkboxes' property value is true.
|
clearFilter
|
()
|
void
|
Clears the widget's filter when filtering is applied.
|
destroy
|
()
|
void
|
|
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 jqxDropDownList 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 itemValue)
|
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.
|
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.
|
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)
|
void
|
Inserts a new item to the jqxDropDownList. 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
|
|
loadFromSelect
|
(string arg)
|
void
|
Loads list items from a 'select' tag.
|
open
|
()
|
void
|
|
removeItem
|
(object item)
|
void
|
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)
|
void
|
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
|
|
setContent
|
(string content)
|
void
|
Sets the content of the DropDownList.
|
updateItem
|
(object newItem, object item)
|
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, double 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
|
|
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
|
|
uncheckAll
|
()
|
void
|
Unchecks all list items when the 'checkboxes' property value is true.
|
val
|
[SET] (string value) [GET] ()
|
[SET] void [GET] string
|
|