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 before the widget is disposed of.
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.
Main article: onDisposing
See Also
groupRendered
Raised when a group element 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 Knockout is used.
The current group's data.
The group's container. It is an HTML Element or a jQuery Element when you use jQuery.
The group's index.
Main article: onGroupRendered
See Also
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
Raised when a collection item is clicked or tapped.
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 object.
The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
Use 'event' instead.
The jQuery event that caused the function's execution. Deprecated in favor of the event field.
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
Main article: onItemClick.
See Also
itemContextMenu
Raised when a collection item is right-clicked or pressed.
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 target item's data object.
The target item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The target item's index. In a grouped list, the index is specified as an object defining group and item indexes: { group: 0, item: 0 }.
Use 'event' instead.
The jQuery event that caused the function's execution. Deprecated in favor of the event field.
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
Main article: onItemContextMenu
See Also
itemDeleted
Raised after a list item is deleted from the data source.
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 removed item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The removed item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
Main article: onItemDeleted
See Also
- List - Handle Deletion-Related Events
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
itemDeleting
Raised before a collection item is deleted from the data source.
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 to be removed.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
Allows you to cancel the item deletion.
Main article: onItemDeleting
See Also
itemHold
Raised when a collection item has been held for a specified period.
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 object of the item being held.
The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery.
The index of the item being held. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
The jQuery event that caused the function's execution. Deprecated in favor of the event field.
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
Main article: onItemHold
See Also
itemRendered
Raised 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.
Main article: onItemRendered
See Also
itemReordered
Raised after a list item is moved to another position.
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 reordered item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The item's index after reordering. This field holds the same value as toIndex.
In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
The item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
Main article: onItemReordered
See Also
- List - Handle Reordering-Related Events
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
itemSwipe
Raised when a list item is swiped.
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.
Use 'event' instead.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
The swiped item's data.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
The direction in which the item is swiped.
Main article: onItemSwipe
See Also
- List - Touch-Screen Gestures
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
The widget's instance.
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
The path to the modified option that includes all parent options.
The modified 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.
Main article: onOptionChanged
See Also
pageLoading
Raised before the next page is loaded.
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.
Main article: onPageLoading
See Also
pullRefresh
Raised when the "pull to refresh" gesture 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 Knockout is used.
Main article: onPullRefresh
See Also
- List - Touch-Screen Gestures
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
scroll
Raised on each scroll gesture.
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.
Use 'event' instead.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
The current scroll offset in the following format { top: topOffset, left: leftOffset }.
Indicates whether the container's left boundary is reached.
Indicates whether the container's right boundary is reached.
Indicates whether the container's top boundary is reached.
Indicates whether the container's bottom boundary is reached.
Main article: onScroll
See Also
- List - Handle Scrolling-Related Events
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
selectAllValueChanged
Raised when the "Select All" check box value is changed.
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.
Main article: onSelectAllValueChanged
See Also
- List - Handle Selection-Related Events
- Handle Events: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
selectionChanged
Raised when a collection item is selected or selection is canceled.
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