[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications, and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Property Grid
  [Expand]Pivot Grid
  [Expand]Member Tables
  [Collapse]Tree List
   [Expand]Product Information
   [Expand]Feature Center
   [Collapse]Visual Elements
     Automatic Filtering Row
     Blank Column
     Caption Panel
     Cell
     Column
     Column Button
     Column Header
     Column Header Context Menu
     Column Header Panel
     Column Separators
     Column's Filter DropDown
     Customization Form
     Empty Area
     Expand Button
     Filter Button
     Filter Editor
     Filter Panel
     Find Panel
     Fixed Line
     Footer Cell
     Footer Context Menu
     Group Footer
     Node Image
     Node Indents
     Node Indicator Panel
     Summary Footer
   [Expand]Design-Time Features
   [Expand]Examples
   [Expand]End User Capabilities
   [Expand]Member Tables
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
  [Expand]Sunburst Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[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)

Automatic Filtering Row

The automatic filtering row allows end-users to filter Tree List records on-the-fly, without invoking the Filter Editor dialog. This row is displayed above regular Tree List nodes.

Each cell of the automatic filtering row displays two elements.

  • A selector for setting the required filter condition. The set of conditions available for a column depends on the type of data this column displays.
  • An editor that allows end-users to enter a value for filtering column data.

The following animation illustrates how end-users can work with the auto-filter row.

Expanded Enable Automatic Filtering Row

Use the TreeListOptionsView.ShowAutoFilterRow property (accessible from TreeList.OptionsView) to enable the automatic filtering row.

Expanded API

The table below enumerates public API related to the automatic filtering row.

Property

Description

TreeListOptionsFilter.AllowAutoFilterConditionChange

Specifies whether or not the auto-filtering row's condition selector is visible.

TreeListOptionsColumnFilter.AutoFilterCondition

Specifies the filter criteria operator for this column ("Equals", "Like", "Greater", etc.).

TreeListOptionsColumnFilter.ImmediateUpdateAutoFilter

If this setting is enabled, Tree List will filter its records immediately as end-users modify the filter condition. Otherwise, filtering will not be applied until a user presses the Enter key or moves focus to another cell.

TreeList.ShowAutoFilterConditionsMenu

Call this method from code to invoke the automatic filtering row popup menu for a specific column.

TreeList.GetAutoFilterValue

TreeList.SetAutoFilterValue

Methods that allow you to retrieve the currently applied auto-filtering row condition and apply a new one from code.

TreeList.ResetAutoFilterConditions

Clears all data filtering applied through the automatic filtering row.

To modify items within the filter condition selector menu, handle the TreeList.PopupMenuShowing event. The code below illustrates how to change the condition text from "Is greater than" to "After this date" for all DateTime columns.

Expanded Automatic Filtering Row Without the Condition Selector

Prior to version 17.1, the automatic filtering row had no condition selector. You can switch back to this type of automatic filtering by disabling the TreeListOptionsFilter.AllowAutoFilterConditionChange or WindowsFormsSettings.AllowAutoFilterConditionChange properties. Alternatively, you can set the WindowsFormsSettings.DefaultSettingsCompatibilityMode property to the v16 value.

For columns that utilize CheckEdit, LookUpEdit and ImageComboBoxEdit controls as in-place editors, filtering values will be compared with cell values using the "Equals" operator. For other columns, the "Like" operator is applied.

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