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

element: jQuery

The widget's container.

model: Object

Data that is available for binding against the element. Available only in the Knockout approach.

Main article: onContentReady.

See Also

contextMenuPreparing

Fires before displaying a context menu invoked by a right-click on one of the field chooser's fields.

Event Handler Argument:

Information about the event.

Object structure:
component: Object

The widget instance.

element: jQuery

The widget's container.

model: Object

Data that is available for binding against the element. Available only in the Knockout approach.

items: Array

An array of items to be displayed by the context menu. The item objects must have the fields that are used by the ContextMenu default item template.

area: String

The clicked area type.

field: Object

Options of the clicked field.

jQueryEvent: jQuery.Event

The jQuery event.

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

Handle this event to change the set of items in the context menu before it is displayed.

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

element: jQuery

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after an option of the widget is changed.

Event Handler Argument:

Information about the event.

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