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

Object

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

closed

Fires after a drop-down list has been hidden.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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 onClosed option to handle the event.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

jQuery

The widget's container.

model:

Object

The model data. Available only when using Knockout.

Main article: onContentReady.

See Also

copy

Fires after the widget's input has been copied.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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

Object

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

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

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

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

Object

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

Object

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

Object

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

Object

The widget's 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:
component:

Object

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

itemClick

Fires when a widget item is clicked.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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.

itemData:

Object

The data that is bound to the clicked item.

itemElement:

Object

An HTML element of the item.

itemIndex:

Number

|

Object

The index of the clicked item. If the widget items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Instead, you can use the onItemClick 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:
component:

Object

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

Object

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

Object

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

opened

Fires when the drop-down editor is shown.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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 onOpened option to handle the event.

See Also

optionChanged

Raised after an option of the widget is changed.

Type:

Event

Function parameters:
e:

Object

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

paste

Fires after the widget's input has been pasted.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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

selectionChanged

Fires when the selection changes.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

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.

selectedItem:

Object

Provides access to the currently selected item.

Instead, you can use the onSelectionChanged 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:
component:

Object

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