Events

This section describes events fired by this widget.

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only when using Knockout.

Main article: onContentReady.

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

Main article: onDisposing

groupRendered

Raised when a group element is rendered.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
groupData	Object	The current group's data.
groupElement	Element (jQuery or HTML)	The group's container. It is an HTML Element or a jQuery Element when you use jQuery.
groupIndex	Number	The group's index.
model	Object	The model data. Available only if Knockout is used.

Main article: onGroupRendered

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

itemClick

Raised when a collection item is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The clicked item's data object.
itemElement	Element (jQuery or HTML)	The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the function's execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.

Main article: onItemClick.

itemContextMenu

Raised when a collection item is right-clicked or pressed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The target item's data object.
itemElement	Element (jQuery or HTML)	The target item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	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 }.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the function's execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.

Main article: onItemContextMenu

itemDeleted

Raised after a list item is deleted from the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The removed item's data.
itemElement	Element (jQuery or HTML)	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	The removed item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
model	Object	The model data. Available only if Knockout is used.

Main article: onItemDeleted

itemDeleting

Raised before a collection item is deleted from the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean \| Promise<void> (jQuery or native)	Allows you to cancel the item deletion.
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The data of the item to be removed.
itemElement	Element (jQuery or HTML)	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
model	Object	The model data. Available only if you use Knockout.

Main article: onItemDeleting

itemHold

Raised when a collection item has been held for a specified period.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The data object of the item being held.
itemElement	Element (jQuery or HTML)	The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	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 }.
model	Object	The model data. Available only if Knockout is used.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the function's execution. Deprecated in favor of the event field.

Main article: onItemHold

itemRendered

Raised after a collection item is rendered.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The current item's data.
itemElement	Element (jQuery or HTML)	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The current item's index.
model	Object	The model data. Available only if you use Knockout.

Main article: onItemRendered

itemReordered

Raised after a list item is moved to another position.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
fromIndex	Number	The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemData	Object	The reordered item's data.
itemElement	Element (jQuery or HTML)	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	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 }.
model	Object	The model data. Available only if Knockout is used.
toIndex	Number	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

itemSwipe

Raised when a list item is swiped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
direction	String	The direction in which the item is swiped.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The swiped item's data.
itemElement	Element (jQuery or HTML)	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.

Main article: onItemSwipe

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
fullName	String	The path to the modified option that includes all parent options.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

Main article: onOptionChanged

pageLoading

Raised before the next page is loaded.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.

Main article: onPageLoading

pullRefresh

Raised when the "pull to refresh" gesture is performed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.

Main article: onPullRefresh

scroll

Raised on each scroll gesture.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.
reachedBottom	Boolean	Indicates whether the container's bottom boundary is reached.
reachedLeft	Boolean	Indicates whether the container's left boundary is reached.
reachedRight	Boolean	Indicates whether the container's right boundary is reached.
reachedTop	Boolean	Indicates whether the container's top boundary is reached.
scrollOffset	Object	The current scroll offset in the following format { top: topOffset, left: leftOffset }.

Main article: onScroll

selectAllValueChanged

Raised when the "Select All" check box value is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
value	Boolean	The "Select All" check box's state.

Main article: onSelectAllValueChanged

selectionChanged

Raised when a collection item is selected or selection is canceled.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
addedItems	Array<any>	The data of the items that have been selected.
component	List	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
removedItems	Array<any>	The data of the items whose selection has been canceled.

Main article: onSelectionChanged

General Information

.NET Subscription

Common Tools

Desktop

Controls

Tools

Web

Controls and Extensions

Tools

Mainteinance Mode

Enterprise and Analytic Tools

Quality Assurance and Productivity

Frameworks and Libraries

Mobile

General Information

.NET Subscription

Common Tools

Desktop

Controls

Tools

Web

Controls and Extensions

Tools

Mainteinance Mode

Enterprise and Analytic Tools

Quality Assurance and Productivity

Frameworks and Libraries

Mobile

Events

See Also

contentReady

See Also

disposing

See Also

groupRendered

See Also

initialized

See Also

itemClick

See Also

itemContextMenu

See Also

itemDeleted

See Also

itemDeleting

See Also

itemHold

See Also

itemRendered

See Also

itemReordered

See Also

itemSwipe

See Also

optionChanged

See Also

pageLoading

See Also

pullRefresh

See Also

scroll

See Also

selectAllValueChanged

See Also

selectionChanged

See Also