Events
This section describes events fired by this widget.
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
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.
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
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 you use Knockout.
The clicked item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The clicked item's index.
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 onItemClick option to handle the event.
See Also
itemContextMenu
Fires when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.
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 item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The item's index.
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 onItemContextMenu option to handle the event.
See Also
itemHold
Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.
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 data of the item being held.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The item's index.
Instead, you can use the onItemHold option to handle the event.
See Also
itemRendered
Fires after a collection item 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 if you use Knockout.
The current item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The current item's index.
Instead, you can use the onItemRendered option to handle the event.
See Also
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.
selectionChanged
Fires after a collection item is selected or unselected.
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.
Array<any>
The data of the items that have been selected.
Array<any>
The data of the items whose selection has been canceled.
Main article: onSelectionChanged