DxFilterBuilderField.EditSettings Property

Allows you to customize the editor associated with this field.

Assembly : DevExpress.Blazor.v25.2.dll

Declaration

csharp

[DefaultValue(null)]
[Parameter]
public RenderFragment EditSettings { get; set; }

Property Value

Type	Default	Description
RenderFragment	null

Editor settings.

Remarks

The Filter Builder component generates and configures value editors for individual fields based on associated data types. You can use the EditSettings property for the following tasks:

Access the editor’s API.
Specify a different editor (choose from compatible DevExpress types such as DxComboBoxSettings or DxCheckBoxSettings).

If your customization tasks go beyond what’s possible with the built-in API, use the DxFilterBuilderField.ValueEditTemplate property.

The table below list classes that define value editor settings and the corresponding data types:

Editor Settings

Generated for Data Types

Supported Data Types

| | --- | --- | --- | |

DxCheckBoxSettings

Boolean

All data types

| |

DxComboBoxSettings

Enum

All data types

| |

DxDateEditSettings

DateOnly, DateTime, DateTimeOffset

| |

DxMaskedInputSettings

Never generated

Numeric, String, TimeSpan, TimeOnly,
DateTime, DateOnly, DateTimeOffset

| |

Never generated

| |

| |

| |

TimeOnly, TimeSpan, DateTime

If the editor does not support the associated data type, the Filter Builder replaces it with a read-only text box.

Example

The following code snippet applies a mask to the Total currency field and configures a ComboBox for the Status enum field:

razor

<DxFilterBuilder>
    <Fields>
        <DxFilterBuilderField FieldName="Total" Type="typeof(decimal)">
            <EditSettings>
                <DxSpinEditSettings Mask="c0" DisplayFormat="c0" />
            </EditSettings>
        </DxFilterBuilderField>
        <DxFilterBuilderField FieldName="Status" Type="typeof(string)">
            <EditSettings>
                <DxComboBoxSettings Data="StatusList" />
            </EditSettings>
        </DxFilterBuilderField>
    </Fields>
</DxFilterBuilder>

@code {
    IEnumerable<string> StatusList = new List<string>() {
        "New",
        "Postponed",
        "Fixed",
        "Rejected"
    };
}

Run Demo: Filter Builder