Events

This section describes the events this widget raises.

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

FilterBuilder

The widget instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

editorPrepared

Raised after an editor is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

FilterBuilder

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

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 field's value after the editor's value changes.

editorElement:

Element (jQuery or HTML)

The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.

editorName:

String

The editor's name.

dataField:

String

The data field's name.

filterOperation:

String

The applied filter operation.

updateValueTimeout:

Number

Gets and sets the delay between when a user stops typing the 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:

FilterBuilder

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

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's value after the editor's value changes

cancel:

Boolean

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

editorElement:

Element (jQuery or HTML)

The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.

editorName:

String

Allows you to change the editor. Accepts names of DevExtreme widgets only, for example, "dxTextBox".
Import a new editor's module when using DevExtreme modules.

editorOptions:

Object

Gets and sets the editor configuration.

dataField:

String

The data field's name.

filterOperation:

String

The applied filter operation.

updateValueTimeout:

Number

Gets and sets the delay between when a user stops typing the field's 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:

FilterBuilder

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

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:

FilterBuilder

The widget's instance.

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. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

valueChanged

Raised after the widget's value is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

FilterBuilder

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

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

See Also