Events

This section describes the events this widget raises.

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:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also

editorPrepared

Raised after an editor is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

value: any

The editor's value.

setValue(newValue): any

A method that you need to call to change the data field's value after the editor's value is changed.

editorElement:

Element (jQuery or HTML)

The editor's container.

editorName:

String

The editor's name.

dataField:

String

The data field's name.

updateValueTimeout:

Number

Gets and sets the delay between when a user stops typing a field value and when it is applied.

width:

Number

The editor's width.

readOnly:

Boolean

Indicates whether the editor is read-only.

disabled:

Boolean

Indicates whether the editor is disabled.

rtlEnabled:

Boolean

Indicates whether the editor uses right-to-left representation.

Main article: onEditorPrepared

See Also

editorPreparing

Raised before an editor is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

value: any

The editor's value.

setValue(newValue): any

A method that you should call to change the field value after the editor's value is changed.

cancel:

Boolean

Allows you to cancel the creation of the editor.
Set it to true and implement a custom editor if your scenario requires it.

editorElement:

Element (jQuery or HTML)

The editor's container.

editorName:

String

Allows you to change the editor. Accepts names of DevExtreme widgets only, for example, "dxTextBox".

editorOptions:

Object

Gets and sets the editor configuration.

dataField:

String

The data field's name.

updateValueTimeout:

Number

Gets and sets the delay between when a user stops typing a field value and when it is applied.

width:

Number

The editor's width.

readOnly:

Boolean

Indicates whether the editor is read-only.

disabled:

Boolean

Indicates whether the editor is disabled.

rtlEnabled:

Boolean

Indicates whether the editor uses right-to-left representation.

Main article: onEditorPreparing

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:

Element (jQuery or HTML)

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also

valueChanged

Raised after the widget's value is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

value:

Object

The widget's new value.

previousValue:

Object

The widget's previous value.

Main article: onValueChanged