Vue FilterBuilder Props

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

See Also

• Filter Hierarchical Fields

You can configure this option in an ASP.NET MVC Control as follows:

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

This option accepts an array of objects, each configuring a filter condition's appearance. Each condition consists of a data field, operation and value. A logical operation can combine conditions on the same level in a group.

See the Field section for details on fields you can specify in each object.

View Demo

This option accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

• Function
  A function returning either of the above. For example:

  JavaScript

  height: function() {
      return window.innerHeight / 1.5;
  }

The widget offers a user a different editor for entering a value depending on the field's dataType: Calendar, TextBox, SelectBox, etc. You can customize automatically created editors using this handler.

The widget offers a user a different editor for entering a value depending on the field's dataType: Calendar, TextBox, SelectBox, etc. Within this handler, you can customize a default editor or substitute it for another DevExtreme editor. To do the latter, assign the editor's name to the editorName field and then configure the editor in the editorOptions object. If you specify the editor's onValueChanged handler, call the setValue(newValue) method in it to update the value.

$(function() {
    $("#filterBuilder").dxFilterBuilder({
        // ...
        onEditorPreparing: function(e) {
            if (e.dataField == "name") {
                e.editorName = "dxTextArea";
                e.editorOptions.showClearButton = true;
                e.editorOptions.onValueChanged = function (e) {
                    var value = e.value;
                    if(value == "") {
                        alert("TextArea is empty");
                        return;
                    }
                    e.setValue(value);
                }
            }
        }
    });
});

import { DxFilterBuilderModule } from 'devextreme-angular';
// ...
export class AppComponent {
    onEditorPreparing (e) { 
        if (e.dataField == "name") {
            e.editorName = "dxTextArea";
            e.editorOptions.showClearButton = true;
            e.editorOptions.onValueChanged = function (e) {
                var value = e.value;
                if (value == "") {
                    alert("TextArea is empty");
                    return;
                }
                e.setValue(value);
            }
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxFilterBuilderModule
    ],
    // ...
})

<dx-filter-builder ...
    (onEditorPreparing)="onEditorPreparing($event)">
</dx-filter-builder>

If you use a third-party editor, cancel the default editor creation and then implement your one. Call the setValue(newValue) method in the onEditorPreparing handler to notify the FilterBuilder of the changed value.

$(function() {
    $("#filterBuilder").dxFilterBuilder({
        // ...
        onEditorPreparing: function(e) {
            if(e.dataField === "hidden") {
                e.cancel = true;
                $('<input type="checkbox">')
                    .prop("checked", e.value)
                    .on("change", function(args) {
                        e.setValue(args.target.checked);
                    })
                    .appendTo(e.editorElement);
            }
        }
    });
});

import { DxFilterBuilderModule } from 'devextreme-angular';
// ...
export class AppComponent {
    onEditorPreparing (e) { 
        if(e.dataField === "hidden") {
            e.cancel = true;
            let checkbox = document.createElement("INPUT");
            checkbox.setAttribute("type", "checkbox");
            checkbox.setAttribute("checked", e.value);
            checkbox.addEventListener("change", function(args) {
                                                    e.setValue(args.target.checked);
                                                });
            e.editorElement.appendChild(checkbox);
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxFilterBuilderModule
    ],
    // ...
})

<dx-filter-builder ...
    (onEditorPreparing)="onEditorPreparing($event)">
</dx-filter-builder>

You cannot access widget elements in this handler because it is executed before they are ready.

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

See Also

• Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

See Also

• Data Layer - Filtering

This option accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

• Function
  A function returning either of the above. For example:

  JavaScript

  width: function() {
      return window.innerWidth / 1.5;
  }