Filter List Editors in the UI

• 5 minutes to read

List Editors include various UI controls for filtering List View data. This topic lists supported filter controls.

Auto Filter Row

The Auto Filter Row adds a row to the top of the grid where users can enter values to filter each column independently.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor, DxTreeListEditor
• Windows Forms: GridListEditor, TreeListEditor, PivotGridListEditor

How to Display the Control

• Use the ShowAutoFilterRow property to toggle Auto Filter Row visibility for the current List View.
• Use the DefaultListViewShowAutoFilterRow property to toggle Auto Filter Row visibility in an object’s default List View.

Filter Saving in the Application Model

XAF saves the Auto Filter Row filter in the Application Model, so it persists even if a user closes the View. Use the IModelListView.Filter property to preset the filter in the Model Editor.

See Also

• Filter Large List Views With Auto Filter Row
• LookupColumnFilterMode

Column Header Filters

A Column Header Filter displays a drop-down list that contains all unique values within a column.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor, DxTreeListEditor, DxPivotGridListEditor
• Windows Forms: GridListEditor, TreeListEditor, PivotGridListEditor

How to Display the Control

List Editors always display Column Header Filters.

Filter Saving in the Application Model

XAF saves column header filters in the Application Model, so they persist even if a user closes the View. Use the IModelListView.Filter property to preset the filter in the Model Editor.

See Also

• ShowColumnHeaders
• FilterMenuButtonDisplayMode

Filter Builder

The Filter Builder is a visual editor for creating complex filter conditions. Click the FilterEditor Action or a filter expression in the Filter Panel to open it.

The Filter Builder uses the internal DevExpress.ExpressApp.Blazor.Components.FilterEditor component, which does not expose a public API in Blazor applications and the FilterEditorControl component in Windows Forms applications.

Note

Set DevExpress.ExpressApp.Blazor.Editors.CriteriaPropertyEditor.UseAsDefaultCriteriaEditor to true to use the DxFilterBuilder component in Blazor applications.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor, DxTreeListEditor, DxChartListEditor
• Windows Forms: GridListEditor, TreeListEditor, PivotGridListEditor

Filter Saving in the Application Model

XAF saves Filter Builder filters in the Application Model, so the filter persists even if a user closes the View. Use the IModelListView.Filter property to preset the filter in the Model Editor.

See Also

• Criteria Properties

ASP.NET Core Blazor:

• The FilterBuilderComponentModel property contains the component model used to modify Filter Builder properties.
• The FilterBuilderCustomizeField event allows you to customize data source field settings.
• The FilterBuilderCustomizeFieldEditSettings event allows you to customize field editor settings.
• The FilterBuilderCustomizeFieldVisibility event allows you to hide data source fields from Filter Builder.

Windows Forms:

• Control which properties are available in a Filter Builder
• The FilterEditorCreated event provides access the currently used Filter Control.
• The CreateCustomFilterEditorRepositoryItem event allows you to create a custom repository item in the Filter Builder.
• The CustomizeFilterTreeNodeModelPropertyCaption event allows you to customize a property caption when it appears in the Filter Builder.

Filter Panel

The Filter Panel displays the currently applied filter expression below the grid.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor, DxTreeListEditor
• Windows Forms: GridListEditor, TreeListEditor, PivotGridListEditor

How to Display the Control

The Filter Panel is visible when List Editor content is filtered. To make the Filter Panel always visible, add the following controller to your application:

SolutionName.Blazor.Server/Controllers/GridFilterPanelController.cs

using DevExpress.Blazor;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Blazor.Editors;

namespace SolutionName.Blazor.Server.Controllers;

public class GridFilterPanelController : ViewController<ListView> {

    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        if (View.Editor is DxGridListEditor gridListEditor) {
            gridListEditor.GridModel.FilterPanelDisplayMode = GridFilterPanelDisplayMode.Always;
        }
    }
}

Find Panel

The Find Panel (also called Search Panel) is a search component that allows users to filter data by typing a search string. The editor searches all visible columns.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor
• Windows Forms: GridListEditor

How to Display the Control

• Use the ShowFindPanel property to control whether the List Editor displays the Find Panel component.
• Use the DefaultListViewShowFindPanel property to toggle Find Panel visibility in an object’s default List View.
• Use ListViewFindPanelAttribute in a business class declaration to specify whether a List View of this type displays the Find Panel.

Filter Saving in the Application Model

Filters applied in the Find Panel are not saved in the Application Model.

See Also

LookupColumnFilterMode

FullTextSearch Action

The FullTextSearch Action allows users to search across all text columns in a List View by entering a search query in the Action’s parameter editor.

Supported List Editors

• ASP.NET Core Blazor: DxGridListEditor, DxTreeListEditor, DxPivotGridListEditor
• Windows Forms: GridListEditor, TreeListEditor, PivotGridListEditor, SchedulerListEditor

Filter Saving in the Application Model

The filters applied by the FullTextSearch Action are not saved in the Application Model.

See Also

• FullTextSearch Action
• How to: Make the FullTextSearch Action Search Within Required Properties
• How to: Add a Search Action to Lookup Property Editors and Link Pop-up Windows
• FullTextFilterAction

SetFilter Action

The SetFilter Action displays predefined filter criteria in a drop-down window. Selecting a criterion filters the current List View.

Supported List Editors

The SetFilter Action is available in any List Editor.

How to Display the Control

Add predefined filter criteria via the Model Editor.

Filter Saving in the Application Model

XAF saves the selected filter in the Application Model, so the filter persists even if a user closes the View.

See Also

• Filters Application Model Node
• SetFilterAction