[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Collapse]DevExpress.Xpf.Core.FilteringUI
    AllowedDataAnalysisFilters Enumeration
    AllowedExcelStyleFilterTypes Enumeration
   [Expand]BinaryFilterModel Class
   [Expand]CalendarFilterElement Class
   [Expand]CalendarFilterModel Class
   [Expand]CheckBoxFilterElement Class
   [Expand]CheckBoxFilterModel Class
   [Expand]CheckedListFilterElement Class
   [Expand]CheckedListFilterModel Class
   [Expand]CheckedTreeListFilterElement Class
   [Expand]CheckedTreeListFilterModel Class
   [Expand]ConstantFilterModel Class
   [Expand]CustomUniqueValuesEventArgs Class
   [Expand]CustomValueDisplayTextEventArgs Class
   [Expand]DatePeriodFilterValue Class
   [Expand]DatePeriodsFilterElement Class
   [Expand]DatePeriodsFilterModel Class
   [Expand]DateRangeFilterElement Class
   [Expand]DateRangeFilterModel Class
    DateTimeFilterTreeType Enumeration
   [Expand]ExcelStyleFilterElement Class
   [Expand]ExcelStyleFilterElementOperatorItem Class
   [Expand]ExcelStyleFilterElementOperatorItemList Class
    ExcelStyleFilterElementOperatorType Enumeration
   [Expand]ExcelStyleFilterElementQueryOperatorsEventArgs Class
   [Expand]ExcelStyleFilterModel Class
    ExcelStyleFilterType Enumeration
   [Expand]FieldItem Class
   [Expand]FieldList Class
   [Collapse]FilterBehavior Class
     FilterBehavior Members
     FilterBehavior Constructor
    [Expand]FilterBehavior Properties
    [Expand]FilterBehavior Events
    [Expand]FilterBehavior Methods
   [Expand]FilterChangedEventArgs Class
   [Expand]FilterEditorCommands Class
   [Expand]FilterEditorControl Class
   [Expand]FilterEditorOperatorItem Class
   [Expand]FilterEditorOperatorItemList Class
    FilterEditorOperatorType Enumeration
   [Expand]FilterEditorQueryOperatorsEventArgs Class
   [Expand]FilterElement Class
   [Expand]FilterField Class
   [Expand]FilterFieldCollection Class
   [Expand]FilteringUIContext Class
   [Expand]FilterModel Class
   [Expand]FilterModelBase Class
   [Expand]FilterModelValueItem Class
    FilterValuesSortMode Enumeration
   [Expand]FormatConditionFilterElement Class
   [Expand]FormatConditionFilterModel Class
   [Expand]MultiFilterElement Class
   [Expand]MultiFilterModel Class
   [Expand]OperatorItemBase Class
   [Expand]PredefinedFilter Class
   [Expand]PredefinedFilterCollection Class
   [Expand]PredefinedFiltersElement Class
   [Expand]PredefinedFiltersModel Class
    PropertySelectorMode Enumeration
   [Expand]QueryConditionOperationsEventArgs Class
   [Expand]QueryFieldsEventArgs Class
   [Expand]QueryGroupOperationsEventArgs Class
   [Expand]QueryGroupTypesEventArgs Class
   [Expand]QueryOperatorsEventArgsBase<T> Class
   [Expand]RadioListFilterElement Class
   [Expand]RadioListFilterModel Class
   [Expand]RangeFilterElement Class
   [Expand]RangeFilterModel Class
   [Expand]RangeFilterModelBase<T> Class
    StringFilterTreeType Enumeration
   [Expand]TernaryFilterModel Class
   [Expand]VariadicFilterModel Class
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

FilterBehavior Class

Allows you to use the Filter Editor (see FilterEditorControl) / Filter Elements (see FilterElement) to filter data-bound controls that do not provide a filtering UI (for example, Charts and Data Editors).

Namespace:DevExpress.Xpf.Core.FilteringUI
Assembly:DevExpress.Xpf.Grid.v19.2.dll

Expanded Syntax

Expanded Remarks

Filter Elements and ChartControl

Tip

Demo: FilterBehavior - Chart Filtering

Requires a WPF Subscription. Download

The following code sample shows how to use the FilterBehavior to make the Filter Elements (see FilterElement) work with the ChartControl.

  1. Add the FilterBehavior to the behaviors of a container that holds the Filter Elements (see FilterElement). The FilterBehavior automatically specifies the FilterElement.Context properties.
  2. Specify the ItemsSource property to allow the Filter Elements (see FilterElement) to get unique filter values.
  3. Specify the Fields property to configure edit settings.
  4. Bind a data-bound control's filter criteria to the ActualFilterCriteria object.

Filter Elements and Data Editors

Tip

Demo: FilterBehavior - ListBoxEdit Filtering

Requires a WPF Subscription. Download

The following code sample shows how to use the FilterBehavior to make the Filter Elements (see FilterElement) work with the ListBoxEdit.

  1. Add the FilterBehavior to the behaviors of a container that holds the Filter Elements (see FilterElement). The FilterBehavior automatically specifies the FilterElement.Context properties.
  2. Specify the ItemsSource property to allow the Filter Elements (see FilterElement) to get unique filter values.
  3. Specify the Fields property to configure edit settings and predefined filters.
  4. Bind a data-bound control's filter criteria to the ActualFilterCriteria object.

Filter Elements and CollectionView

Tip

Demo: FilterBehavior - CollectionView Filtering

Requires a WPF Subscription. Download

The following code sample shows how to use the FilterBehavior to make the Filter Elements (see FilterElement) work with the Collectionview.

  1. Add the FilterBehavior to the behaviors of a container that holds the Filter Elements (see FilterElement). The FilterBehavior automatically specifies the FilterElement.Context properties.
  2. Specify the ItemsSource property to allow the Filter Elements (see FilterElement) to get unique filter values.
  3. Specify the Fields property to configure edit settings.
  4. The FilterBehavior creates the ActualFilterCriteria object. Use the ActualFilterCriteria object to filter data in code.

ViewModel Data Filtering

Tip

Demo: FilterBehavior - ViewModel Data Filtering

Requires a WPF Subscription. Download

The following code sample shows how to use the FilterBehavior to make the Filter Elements (see FilterElement) filter the ViewModel data.

  1. Add the FilterBehavior to the behaviors of a container that holds the Filter Elements (see FilterElement). The FilterBehavior automatically specifies the FilterElement.Context properties.
  2. Specify the ItemsSource property to allow the Filter Elements (see FilterElement) to get unique filter values.
  3. Specify the Fields property to configure edit settings.
  4. The FilterBehavior creates the ActualFilterCriteria object. Use the ActualFilterCriteria object to filter data in code.

Standalone Filter Editor

Tip

Demo: FilterBehavior - Standalone Filter Editor

Requires a WPF Subscription. Download

The following code sample shows how to use the FilterBehavior to make the Filter Editor (see FilterEditorControl) work with the ChartControl.

  1. Add the FilterBehavior to the behaviors of the Filter Editor (see FilterEditorControl). The FilterBehavior automatically specifies the FilterEditorControl.Context property.
  2. Specify the ItemsSource property to allow the Filter Editor (see FilterEditorControl) to get unique filter values.
  3. Specify the Fields property to configure display fields.
  4. Bind a data-bound control's filter criteria to the ActualFilterCriteria object.

Specify Filter Criteria in Code

Use the FilterString (see FilterString) / FilterCriteria (see FilterCriteria) property to create a filter expression that consists of multiple conditions applied to multiple columns, and apply it to the FilterBehavior. Setting the FilterString (see FilterString) / FilterCriteria (see FilterCriteria) property to a new value clears any filters that have been previously applied.

FilterString Property

FilterCriteria Property

Expanded Inheritance Hierarchy

System.Object
    System.Windows.Threading.DispatcherObject
       System.Windows.DependencyObject
          System.Windows.Freezable
             System.Windows.Media.Animation.Animatable
                DevExpress.Mvvm.UI.Interactivity.AttachableObjectBase
                   DevExpress.Mvvm.UI.Interactivity.Behavior
                      DevExpress.Mvvm.UI.Interactivity.Behavior<System.Windows.FrameworkElement>
                         FilterBehavior

Expanded See Also

Is this topic helpful?​​​​​​​