Events

This section describes the events this widget raises.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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 when using Knockout.

Main article: onContentReady.

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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:
Name Type Description
component

FilterBuilder

The widget's instance.

dataField

String

The data field's name.

disabled

Boolean

Indicates whether the editor is disabled.

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.

element

Element (jQuery or HTML)

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

filterOperation

String

The applied filter operation.

model

Object

The model data. Available only if you use Knockout.

readOnly

Boolean

Indicates whether the editor is read-only.

rtlEnabled

Boolean

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

setValue(newValue) any

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

updateValueTimeout

Number

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

value any

The editor's value.

width

Number

The editor's width.

Main article: onEditorPrepared

See Also

editorPreparing

Raised before an editor is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

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

component

FilterBuilder

The widget's instance.

dataField

String

The data field's name.

disabled

Boolean

Indicates whether the editor is disabled.

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.

element

Element (jQuery or HTML)

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

filterOperation

String

The applied filter operation.

model

Object

The model data. Available only if you use Knockout.

readOnly

Boolean

Indicates whether the editor is read-only.

rtlEnabled

Boolean

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

setValue(newValue) any

A method that you should call to change the field's value after the editor's value changes

updateValueTimeout

Number

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

value any

The editor's value.

width

Number

The editor's width.

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:
Name Type Description
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:
Name Type Description
component

FilterBuilder

The widget's instance.

fullName

String

The path to the modified option that includes all parent options.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified 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:
Name Type Description
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.

previousValue

Object

The widget's previous value.

value

Object

The widget's new value.

Main article: onValueChanged

See Also