Events

This section describes events fired by this widget.

disposing

Fires when the widget is being removed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
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.

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

See Also
NOTE
This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget instance.

element

jQuery

The widget's container.

Main article: onInitialized

See Also

optionChanged

Fires after an option of the component is changed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

name

String

Specifies the name of the option whose value is changed.

fullName

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value any

Specifies a new value for the option.

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.

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

See Also

valueChanged

Fires when the editor value changes.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
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.

value

Object

Returns the widget's new value.

previousValue

Object

Returns the widget's previous value.

jQueryEvent

jQuery.Event

Specifies the jQuery event that caused the action execution.

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

See Also