Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's 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.

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

editorEnterKey

Fires after a user presses the Enter key when an editor is focused.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the form instance.

element: jQuery

An HTML element of the form.

model: Object

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

dataField: String

The path to the formData object field associated with the current editor.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

fieldDataChanged

Fires after the value of a formData object field has been changed.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the form instance.

element: jQuery

An HTML element of the form.

model: Object

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

dataField: String

The path to the formData object field whose value has been changed.

value: Object

The new value of the field.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

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