JavaScript/jQuery TreeView Events
This section describes events fired by this widget.
contentReady
Raised when the widget's content is ready.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
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.
| Name | Type | Description |
|---|---|---|
| component |
The widget instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if you use Knockout. |
Main article: onDisposing
See Also
initialized
Raised only once, after the widget is initialized.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
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.
| Name | Type | Description |
|---|---|---|
| node |
The clicked item's node. |
|
| event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
| jQueryEvent |
The jQuery event that caused the function's execution. Deprecated in favor of the event field. |
|
| itemIndex | | |
The clicked item's index. |
| itemElement |
The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemData |
The clicked item's data object. |
|
| model |
The model data. Available only if Knockout is used. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
Main article: onItemClick.
See Also
itemCollapsed
Raised when a tree view item is collapsed.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| itemData |
The collapsed item's data. |
|
| itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemIndex |
The item's index. |
|
| jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
| event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
| node |
The item's node. |
Main article: onItemCollapsed
See Also
itemContextMenu
Raised when a collection item is right-clicked or pressed.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| node |
The target item's node. |
|
| event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
| jQueryEvent |
The jQuery event that caused the function's execution. Deprecated in favor of the event field. |
|
| itemIndex | | |
The target item's index. |
| itemElement |
The target item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemData |
The target item's data object. |
|
| model |
The model data. Available only if Knockout is used. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
Main article: onItemContextMenu
See Also
itemExpanded
Raised when a tree view item is expanded.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| itemData |
The expanded item's data. |
|
| itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemIndex |
The item's index. |
|
| jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
| event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
| node |
The item's node. |
Main article: onItemExpanded
See Also
itemHold
Raised when a collection item has been held for a specified period.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
| itemIndex |
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 }. |
|
| itemElement |
The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemData |
The data object of the item being held. |
|
| model |
The model data. Available only if Knockout is used. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
|
| node |
The node of the item being held. |
Main article: onItemHold
See Also
itemRendered
Raised after a collection item is rendered.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| itemIndex |
The rendered item's index. |
|
| itemElement |
The rendered item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| itemData |
The rendered item's data object. |
|
| model |
The model data. Available only if Knockout is used. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
|
| node |
The rendered item's node. |
Main article: onItemRendered
See Also
itemSelectionChanged
Raised when a tree view item is selected or the selection is canceled.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| node |
The item's node. |
|
| itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
Main article: onItemSelectionChanged
See Also
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| name |
The option's short name. |
|
| model |
The model data. Available only if you use Knockout. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
|
| fullName |
The option's full name. |
|
| value | any |
The option's new value. |
Main article: onOptionChanged
See Also
selectAllValueChanged
Raised when the "Select All" check box value is changed.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| value |
The "Select All" check box's new state. |
Main article: onSelectAllValueChanged
See Also
selectionChanged
Raised when a tree view item is selected or the selection is canceled.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| model |
The model data. Available only if Knockout is used. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
Main article: onSelectionChanged
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.