Events
This section describes events fired by this widget.
change
Fires when a change within the widget's input element is committed by an end user.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
closed
Fires after a drop-down list has been hidden.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Instead, you can use the onClosed option to handle the event.
See Also
contentReady
Raised when the widget's content is ready.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
If data displayed by the widget is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called as well as when the widget content is ready. In this case, when you create the widget, the contentReady event is raised twice: when the widget's content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).
copy
Fires after the widget's input has been copied.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
customItemCreating
Raised when a user adds a custom item.
The item object or the jQuery Deferred object resolved when the item is created.
cut
Fires after the Cut DOM event has fired.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
enterKey
Fires after the Enter key has been pressed within the widget's input element.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
Instead, you can use the onEnterKey option to handle the event.
See Also
focusIn
Fires after the widget's input has been focused.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
Use the on() method to attach a handler for the focusIn event.
To unsubscribe from this event, use the off() method.
Note that you can handle the focusIn event within the widget's configuration object by assigning your handler to the onFocusIn option.
See Also
focusOut
Fires after the widget's input element has lost focus.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused action execution.
Instead, you can use the onFocusOut option to handle the event.
See Also
initialized
Raised only once, after the widget is initialized.
input
Fires when a value within the widget's input element is changed by an end user.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused the action execution.
itemClick
Fires when a widget item is clicked.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
The data that is bound to the clicked item.
An HTML element of the item.
The index of the clicked item. If the widget items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
Instead, you can use the onItemClick option to handle the event.
See Also
keyDown
Fires when a key is pressed down within the widget's input element.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused the action execution.
keyPress
Fires when the keypress DOM event has been raised for the current input element.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused the action execution.
Instead, you can use the onKeyPress option to handle the event.
See Also
keyUp
Fires when a key is released within the widget's input element.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused the action execution.
opened
Fires when the drop-down editor is shown.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Instead, you can use the onOpened option to handle the event.
See Also
optionChanged
Raised after an option of the widget is changed.
Information about the event.
The widget's instance.
A short name of the option whose value has been changed.
A full name of the option whose value has been changed; contains a full hierarchy of the option.
A new value for the option.
The widget's container.
The model data. Available only if you use Knockout.
paste
Fires after the widget's input has been pasted.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Specifies the jQuery event that caused the action execution.
selectAllValueChanged
Fires when the select all check box value changes.
Instead, you can use the onSelectAllValueChanged option to handle the event.
See Also
selectionChanged
Fires when the selection changes.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Provides access to the newly added items.
Provides access to the newly unselected items.
Instead, you can use the onSelectionChanged option to handle the event.
See Also
valueChanged
Fires when the editor value changes.
Provides function parameters.
The widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Returns the widget's new value.
Returns the widget's previous value.
Specifies the jQuery event that caused the action execution.
Instead, you can use the onValueChanged option to handle the event.