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:
component:

Object

The widget's instance.

element:

jQuery

The widget's container.

model:

Object

The model data. Available only when using Knockout.

disposing

Fires when the widget is being removed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onDisposing option to handle the event.

See Also
NOTE
This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

Main article: onInitialized

See Also

itemClick

Fires when a widget item is clicked.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

itemData:

Object

The data that is bound to the clicked item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the clicked item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Instead, you can use the onItemClick option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

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.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

itemData:

Object

The data that is bound to the item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Instead, you can use the onItemContextMenu option to handle the event.

See Also

itemRendered

Fires after a collection item is rendered.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

itemData:

Object

The data that is bound to the item to be rendered.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the rendered item.

Instead, you can use the onItemRendered option to handle the event.

See Also

optionChanged

Fires after an option of the component is changed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onOptionChanged option to handle the event.

See Also

selectionChanged

Fires after a collection item is selected or unselected.

Type:

Event (jQuery or dxEvent)

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

addedItems:

Array

An array of items added to selection.

removedItems:

Array

An array of items removed from selection.

Instead, you can use the onSelectionChanged option to handle the event.

This event fires only if the selectionMode option is set to 'single' and the selectByClick option is set to true.

See Also
Show Example:
AngularJS
Knockout
jQuery

submenuHidden

Fires when the submenu is hidden.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem:

jQuery

A jQuery object of the root menu element for which the submenu is hidden.

Instead, you can use the onSubmenuHidden option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

submenuHiding

Fires before the submenu is hidden.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem:

jQuery

A jQuery object of the root menu element for which the submenu is being hidden.

cancel:

Boolean

Specifies whether or not to cancel the hiding of the widget.

Instead, you can use the onSubmenuHiding option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

submenuShowing

Fires before the submenu is displayed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem:

jQuery

A jQuery object of the root menu element for which the submenu is being displayed.

Instead, you can use the onSubmenuShowing option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

submenuShown

Fires when the submenu is displayed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem:

jQuery

A jQuery object of the root menu element for which the submenu is displayed.

Instead, you can use the onSubmenuShown option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery