Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also

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's instance.

element:

Element (jQuery or HTML)

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

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:

Element (jQuery or HTML)

The item's container.

itemIndex:

Number

Specifies the index of the clicked item.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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
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's instance.

element:

Element (jQuery or HTML)

The widget's container.

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:

Element (jQuery or HTML)

The item's container.

itemIndex:

Number

Specifies the index of the item.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

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:

Element (jQuery or HTML)

The item's container.

itemIndex:

Number

Specifies the index of the rendered item.

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

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also

selectionChanged

Fires after a collection item is selected or unselected.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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

addedItems:

Array<any>

An array of items added to selection.

removedItems:

Array<any>

An array of items removed from selection.

Main article: onSelectionChanged

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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

rootItem:

Element (jQuery or HTML)

The container 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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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

rootItem:

Element (jQuery or HTML)

The container 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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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

rootItem:

Element (jQuery or HTML)

The container 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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

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

rootItem:

Element (jQuery or HTML)

The container 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