DataViewBase.SearchPanelAllowFilter Property

Gets or sets whether the grid displays only those records that match the search criteria. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public bool SearchPanelAllowFilter { get; set; }

VB.NET

Public Property SearchPanelAllowFilter As Boolean

Property Value

Type	Default	Description
Boolean	true	true, to display only those records that match the search criteria; otherwise, false.

Remarks

Read Tutorial: Search

You can specify how to display search results:

• Hide records that do not match the query (SearchPanelAllowFilter).
• Highlight results in the view (DataViewBase.SearchPanelHighlightResults).
• Display scrollbar annotations for search results (TableView.ScrollBarAnnotationMode / TreeListView.ScrollBarAnnotationMode).

SearchPanelAllowFilter = true, SearchPanelHighlightResults = true

SearchPanelAllowFilter = false, SearchPanelHighlightResults = true, ScrollBarAnnotationMode = SearchResult

Run Demo: Search Panel - Filter Mode Run Demo: Search Panel - Highlight Mode

The GridControl raises filter events (FilterChanged, FilterGroupSortChanging, and so on) when users search data with the SearchPanelAllowFilter option enabled.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SearchPanelAllowFilter 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

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/CS/DevExpress.Example01/MainWindow.xaml#L24

ShowSearchPanelMode="Never"
SearchPanelAllowFilter="False"
ShowTotalSummary="True"/>

how-to-use-scrollbar-annotations-t534664/CS/WpfApplication25/MainWindow.xaml#L29

<dxg:GridControl.View>
    <dxg:TableView x:Name="myView" AllowPerPixelScrolling="True" ShowSearchPanelMode="Always" ScrollBarAnnotationMode="{Binding EditValue, ElementName= myListBoxEdit, UpdateSourceTrigger=PropertyChanged, Mode=TwoWay }" ScrollBarCustomRowAnnotation ="MyScrollBarCustomRowAnnotationEventHandler" SearchPanelAllowFilter="False" Loaded="MyLoadedEventHandler">
        <dxg:TableView.FormatConditions>