Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Event Handler Argument:
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.

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 Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

initialized

Raised only once, after the widget is initialized.

Event Handler Argument:
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.

Event Handler Argument:
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.

Event Handler Argument:
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.

Event Handler Argument:
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

Raised after an option of the widget is changed.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
name: String
A short name of the option whose value has been changed.
fullName: String
A full name of the option whose value has been changed; contains a full hierarchy of the option.
value: any
A new value for the option.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

selectionChanged

Fires after a collection item is selected or unselected.

Event Handler Argument:
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.

Event Handler Argument:
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.

Event Handler Argument:
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.

Event Handler Argument:
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.

Event Handler Argument:
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