Free Trial Buy

Events

This section describes events fired by this widget.

See Also

change

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

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

jQuery.Event

Specifies the jQuery event that caused action execution.

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

See Also

copy

Fires after the widget's input has been copied.

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

jQuery.Event

Specifies the jQuery event that caused action execution.

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

See Also

cut

Fires after the Cut DOM event has fired.

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

jQuery.Event

Specifies the jQuery event that caused action execution.

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

See Also

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.

enterKey

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

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

jQuery.Event

Specifies the jQuery event that caused action execution.

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

See Also

focusIn

Fires after the widget's input has been focused.

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

jQuery.Event

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.

See Also

focusOut

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

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

jQuery.Event

Specifies the jQuery event that caused action execution.

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

See Also

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

input

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

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

jQuery.Event

Specifies the jQuery event that caused the action execution.

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

See Also

keyDown

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

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

jQuery.Event

Specifies the jQuery event that caused the action execution.

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

See Also

keyPress

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

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

jQuery.Event

Specifies the jQuery event that caused the action execution.

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

See Also

keyUp

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

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

jQuery.Event

Specifies the jQuery event that caused the action execution.

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

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

paste

Fires after the widget's input has been pasted.

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

jQuery.Event

Specifies the jQuery event that caused the action execution.

Instead, you can use the onPaste 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