Events

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

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

copy

Fires after the widget's input has been copied.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

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

cut

Fires after the Cut DOM event has fired.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

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

disposing

Fires when the widget is being removed.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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.

enterKey

Fires after the Enter key has been pressed within the widget's input element.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

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

focusIn

Fires after the widget's input has been focused.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

Use the on() method to attach a handler for the focusIn event.

To unsubscribe from this event, use the off() method.

Note that you can handle the focusIn event within the widget's configuration object by assigning your handler to the onFocusIn option.

focusOut

Fires after the widget's input element has lost focus.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused action execution.

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

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget instance.

element:

The widget's container.

Main article: onInitialized

input

Fires when a value within the widget's input element is changed by an end user.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused the action execution.

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

keyDown

Fires when a key is pressed down within the widget's input element.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused the action execution.

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

keyPress

Fires when the keypress DOM event has been raised for the current input element.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused the action execution.

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

keyUp

Fires when a key is released within the widget's input element.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused the action execution.

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

optionChanged

Fires after an option of the component is changed.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

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:

An HTML element of the widget.

model:

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.

paste

Fires after the widget's input has been pasted.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

jQueryEvent:

Specifies the jQuery event that caused the action execution.

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

valueChanged

Fires when the editor value changes.

Type:

Event

Function parameters:

e:

Provides function parameters.

Object structure:

component:

Provides access to the widget instance.

element:

An HTML element of the widget.

model:

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

value:

Returns the widget's new value.

previousValue:

Returns the widget's previous value.

jQueryEvent: