DxFilterBuilderField Class

Defines a filter builder field.

Assembly : DevExpress.Blazor.v25.2.dll

Declaration

csharp

public class DxFilterBuilderField :
    DxComponentBase,
    IFilterBuilderFieldsOwner,
    INestedSettingsOwner,
    IDisposable

Remarks

A DxFilterBuilderField object implements an individual field displayed in a DxFilterBuilder component. Use DxFilterBuilder.Fields and DxFilterBuilderField.Fields properties to manage collections of root and nested fields.

The DxFilterBuilderField component allows you to specify the following properties:

FieldNameSupplies fields with data.TypeGenerates relevant editors based on data field types.Caption | CaptionFullPathCustomize field captions to be displayed in the tree and in the resulting filter criteria.EditSettingsCustomizes the default editor or replaces it with another editor.AllowSelectionSpecifies whether the field can be selected.

razor

<DxFilterBuilder @bind-FilterCriteria="FilterCriteria" SizeMode="Params.SizeMode">
    <Fields>
        <DxFilterBuilderField FieldName="ProductName" Caption="Product Name" Type="@typeof(string)" />
        <DxFilterBuilderField FieldName="CategoryId" Caption="Category" Type="@typeof(int)">
            <EditSettings>
                <DxComboBoxSettings Data="Categories" ValueFieldName="CategoryId"
                                    TextFieldName="CategoryName" />
            </EditSettings>
        </DxFilterBuilderField>
        <DxFilterBuilderField FieldName="SupplierId" Caption="Supplier"
                              Type="@typeof(int)" AllowSelection="false">
            <Fields>
                <DxFilterBuilderField FieldName="Supplier.CompanyName" Caption="Company Name"
                                      CaptionFullPath="Supplier.Company Name" Type="@typeof(string)" />
                <DxFilterBuilderField FieldName="Supplier.ContactName" Caption="Contact Name"
                                      CaptionFullPath="Supplier.Contact Name" Type="@typeof(string)" />
            </Fields>
        </DxFilterBuilderField>
        <DxFilterBuilderField FieldName="UnitPrice" Caption="Unit Price" Type="@typeof(int)" />
        <DxFilterBuilderField FieldName="UnitsInStock" Caption="Units in Stock" Type="@typeof(int)" />
        <DxFilterBuilderField FieldName="QuantityPerUnit" Caption="Quantity per Unit" Type="@typeof(int)" />
        <DxFilterBuilderField FieldName="Discontinued" Type="@typeof(bool)" />
    </Fields>
</DxFilterBuilder>

Run Demo

For additional information on how to configure fields in the DxFilterBuilder component, refer to the DxFilterBuilder class description.

Implements

Inheritance

Object ComponentBase DxComponentBase DxFilterBuilderField