DataControlBase.FilterCriteria Property

Gets or sets the grid’s filter criteria. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

[Browsable(false)]
public CriteriaOperator FilterCriteria { get; set; }

VB.NET

<Browsable(False)>
Public Property FilterCriteria As CriteriaOperator

Property Value

Type	Description
CriteriaOperator	A CriteriaOperator object which represents filter criteria.

Remarks

Tip

Topic: Filtering in Code

Use the FilterCriteria property to create a filter expression that consists of multiple conditions applied to multiple columns, and apply it to the grid. When you set the FilterCriteria property to a new value, GridControl clears any filters that have been previously applied.

You should create a CriteriaOperator object or its descendant representing the filter expression:

C#

grid.FilterCriteria = (
    new BinaryOperator("OrderDate", new DateTime(1995, 1, 1), BinaryOperatorType.Less) &
    new BinaryOperator("UnitPrice", 10, BinaryOperatorType.Less)) |
    ( new BinaryOperator("OrderDate", new DateTime(1996, 1, 1), BinaryOperatorType.GreaterOrEqual) &
    new BinaryOperator("UnitPrice", 100, BinaryOperatorType.GreaterOrEqual));

VB.NET

grid.FilterCriteria = (
    New BinaryOperator("OrderDate", New DateTime(1995, 1, 1), BinaryOperatorType.Less) And 
    New BinaryOperator("UnitPrice", 10, BinaryOperatorType.Less)) Or 
    (New BinaryOperator("OrderDate", New DateTime(1996, 1, 1), BinaryOperatorType.GreaterOrEqual) And 
    New BinaryOperator("UnitPrice", 100, BinaryOperatorType.GreaterOrEqual)) 

You can apply filter criteria by parsing a filter string with the static CriteriaOperator.Parse method:

C#

grid.FilterCriteria =
    CriteriaOperator.Parse("([OrderDate] < #1/1/1995# AND [UnitPrice] < 10)" +
    " OR ([OrderDate] >= #1/1/1996# AND [UnitPrice] >= 100)");

VB.NET

grid.FilterCriteria = 
    CriteriaOperator.Parse("([OrderDate] < #1/1/1995# AND [UnitPrice] < 10)" & 
    " OR ([OrderDate] >= #1/1/1996# AND [UnitPrice] >= 100)") 

FilterString Property

The DataControlBase.FilterString property allows you to specify a filter string:

Xaml

<dxg:GridControl FilterString="([OrderDate] < #1/1/1995# AND [UnitPrice] < 10) OR ([OrderDate] >= #1/1/1996# AND [UnitPrice] >= 100)" /> 

C#

grid.FilterString = "([OrderDate] < #1/1/1995# AND [UnitPrice] < 10)" +
    " OR ([OrderDate] >= #1/1/1996# AND [UnitPrice] >= 100)";

VB.NET

grid.FilterString = "([OrderDate] < #1/1/1995# AND [UnitPrice] < 10)" & 
    " OR ([OrderDate] >= #1/1/1996# AND [UnitPrice] >= 100)" 

Note

Use a column’s FieldName value to specify a filter expression with the FilterCriteria / DataControlBase.FilterString property. Refer to the How the GridControl Identifies Columns topic for more information.

Related API

Use the DataControlBase.GetColumnFilterCriteria method to obtain a filter applied to a column.

Use the DataControlBase.MergeColumnFilters method to apply a filter to a column(s) preserving the grid’s filter (if applied).

Use the DataControlBase.ClearColumnFilter method to clear the required column’s filter.

End users can modify filters that you set using the FilterCriteria and DataControlBase.FilterString properties. Use the DataControlBase.FixedFilter property to specify a filter criteria that cannot be modified.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterCriteria property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

gridcontrol-how-to-customize-the-filter-editor-dialog-e3899/CS/MainWindow.xaml#L14

<TextBlock Text="DxGrid" FontSize="20" FontWeight="ExtraBold"/>
<dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew" ItemsSource="{Binding Records}" FilterCriteria="{Binding FilterCriteria, Mode=OneWayToSource}" Grid.Row="1">
    <dxg:GridControl.View>

how-to-show-the-appointments-search-result-in-searchresult-view-for-schedulercontrol-simil-t278605/CS/SearchResultViewDemo/SearchResultView.xaml#L14

ItemsSource="{Binding Path=OwnerScheduler.Storage.AppointmentStorage.Items, RelativeSource={RelativeSource Mode=FindAncestor, AncestorType=UserControl}, UpdateSourceTrigger=PropertyChanged}"
FilterCriteria="{Binding Path=FilterCriteria, RelativeSource={RelativeSource Mode=FindAncestor, AncestorType=UserControl}}"
CustomColumnDisplayText="searchResultGrid_CustomGroupDisplayText">

wpf-data-grid-create-filter-ui/CS/WpfApplication27/MainWindow.xaml#L40

</dxmvvm:Interaction.Behaviors>
<dxg:GridControl x:Name="myGrid" Grid.Column="1" ItemsSource="{Binding Orders}" FilterCriteria="{Binding Path=FilterCriteria, ElementName=filteringBehavior}">
    <dxg:GridControl.Bands>

C#

how-to-synchronize-the-dxtreelist-with-the-icollectionview-collectionviewsource-e3238/CS/TreeListControlViewModel/TreeListControlDataModel.cs#L139

if(FilterMode == ModelFilterMode.FilterCriteria) {
    treeListControl.FilterCriteria = FilterCriteria;
    treeListControl.View.AllowColumnFiltering = true;

how-to-show-images-in-a-column-filter-drop-down-window-e3941/CS/Default MVVM/FilterPopupConverter.cs#L52

PropertyDescriptorCollection descriptors = TypeDescriptor.GetProperties(source[0].GetType());
ExpressionEvaluator evaluator = new ExpressionEvaluator(descriptors, grid.FilterCriteria);
return evaluator.Filter(source);

VB.NET

how-to-synchronize-the-dxtreelist-with-the-icollectionview-collectionviewsource-e3238/VB/TreeListControlViewModel/TreeListControlDataModel.vb#L168

If FilterMode = ModelFilterMode.FilterCriteria Then
    treeListControl.FilterCriteria = FilterCriteria
    treeListControl.View.AllowColumnFiltering = True

how-to-show-images-in-a-column-filter-drop-down-window-e3941/VB/Default MVVM/FilterPopupConverter.vb#L50

Dim descriptors As PropertyDescriptorCollection = TypeDescriptor.GetProperties(source(0).GetType())
Dim evaluator As New ExpressionEvaluator(descriptors, grid.FilterCriteria)
Return evaluator.Filter(source)