Events
This section describes events fired by this widget.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
change
Fires when a change within the widget's input element is committed by an end user.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
closed
Fires after a drop-down list has been hidden.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
Instead, you can use the onClosed option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
contentReady
Raised when the widget's content is ready.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only when using Knockout.
Main article: onContentReady.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
copy
Fires after the widget's input has been copied.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
customItemCreating
Raised when a user adds a custom item.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The input field's text.
The field where to place a custom item.
A custom item or a Promise that is resolved after the item is created. It is a native Promise or a jQuery.Promise when you use jQuery.
Main article: onCustomItemCreating
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
cut
Fires after the Cut DOM event has fired.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Event
Information about the event.
The widget instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
enterKey
Fires after the Enter key has been pressed within the widget's input element.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
Instead, you can use the onEnterKey option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
focusIn
Fires after the widget's input has been focused.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
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
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
focusOut
Fires after the widget's input element has lost focus.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
Instead, you can use the onFocusOut option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
initialized
Raised only once, after the widget is initialized.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
Main article: onInitialized
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
input
Fires when a value within the widget's input element is changed by an end user.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
itemClick
Fires when a widget item is clicked.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The clicked item's data.
The item's container.
The clicked item's index. 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
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
keyDown
Fires when a key is pressed down within the widget's input element.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
keyPress
Fires when the keypress DOM event has been raised for the current input element.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
Instead, you can use the onKeyPress option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
keyUp
Fires when a key is released within the widget's input element.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
multiTagPreparing
Raised before the multi-tag is rendered.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only when using Knockout.
The multi-tag's container. It is an HTML Element or a jQuery Element when you use jQuery.
The currently selected items.
Allows you to change the multi-tag's text.
Allows you to cancel replacing ordinary tags with the multi-tag.
Main article: onMultiTagPreparing
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
opened
Fires when the drop-down editor is shown.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
Instead, you can use the onOpened option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
The widget's instance.
The option's short name.
The option's full name.
The option's new value.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
paste
Fires after the widget's input has been pasted.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
selectAllValueChanged
Fires when the select all check box value changes.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The "Select All" check box's state.
Instead, you can use the onSelectAllValueChanged option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
selectionChanged
Fires when the selection changes.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
The data of the items that have been selected.
The data of the items whose selection has been canceled.
Instead, you can use the onSelectionChanged option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
valueChanged
Fires when the editor value changes.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if Knockout is used.
Returns the widget's new value.
Returns the widget's previous value.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
Instead, you can use the onValueChanged option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC