FilterEditorControl.QueryFields Event

Allows you to customize the field list.

Namespace: DevExpress.Xpf.Core.FilteringUI

Assembly: DevExpress.Xpf.Grid.v24.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event EventHandler<QueryFieldsEventArgs> QueryFields

VB.NET

Public Event QueryFields As EventHandler(Of QueryFieldsEventArgs)

Event Data

The QueryFields event's data class is QueryFieldsEventArgs. The following properties provide information specific to this event:

Property	Description
DefaultField	Gets or sets a field that is selected when users create a new filter condition.
Fields	Gets or sets the fields displayed within the field list.
Filter	Gets the current filter criteria specified in the FilterEditorControl.
ShowSearchPanel	Gets or sets whether to show the search panel in the field list.

Remarks

Run Demo: Filter Editor - Customize the Field List

The FilterEditorControl shows a list of the GridControl‘s fields. Use the QueryFields event to customize the field list. The following code sample shows how to add the ShipCountry, ShipCity and ShipAddress fields to the Ship category:

Xaml

<dxg:TableView x:Name="view">
    <dxg:TableView.FilterEditorTemplate>
        <DataTemplate>
            <dxfui:FilterEditorControl QueryFields="OnQueryFields" />
        </DataTemplate>
    </dxg:TableView.FilterEditorTemplate>
</dxg:TableView>

C#

void OnQueryFields(object sender, QueryFieldsEventArgs e) {
    var shipCountry = e.Fields["ShipCountry"];
    var shipCity = e.Fields["ShipCity"];
    var shipAddress = e.Fields["ShipAddress"];

    shipCountry.Caption = "Country";
    shipCity.Caption = "City";
    shipAddress.Caption = "Address";

    e.Fields.Remove(shipCountry);
    e.Fields.Remove(shipCity);
    e.Fields.Remove(shipAddress);

    var shipGroup = new FieldItem { Caption = "Ship" };
    shipGroup.Children.Add(shipCountry);
    shipGroup.Children.Add(shipCity);
    shipGroup.Children.Add(shipAddress);
    e.Fields.Add(shipGroup);
} 

VB.NET

Private Sub OnQueryFields(ByVal sender As Object, ByVal e As QueryFieldsEventArgs)
    Dim shipCountry = e.Fields("ShipCountry")
    Dim shipCity = e.Fields("ShipCity")
    Dim shipAddress = e.Fields("ShipAddress")

    shipCountry.Caption = "Country"
    shipCity.Caption = "City"
    shipAddress.Caption = "Address"

    e.Fields.Remove(shipCountry)
    e.Fields.Remove(shipCity)
    e.Fields.Remove(shipAddress)

    Dim shipGroup = New FieldItem With {
        .Caption = "Ship"
    }
    shipGroup.Children.Add(shipCountry)
    shipGroup.Children.Add(shipCity)
    shipGroup.Children.Add(shipAddress)
    e.Fields.Add(shipGroup)
End Sub