DataViewBase.ShowSearchPanelMode Property

Gets or sets a value that specifies when the Search Panel is displayed.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public ShowSearchPanelMode ShowSearchPanelMode { get; set; }

VB.NET

Public Property ShowSearchPanelMode As ShowSearchPanelMode

Property Value

Type	Description
ShowSearchPanelMode	A ShowSearchPanelMode enumeration member that specifies when the Search Panel is displayed.

Available values:

Name	Description
Default	Never if the GridControl is bound to a virtual source; otherwise, HotKey.
HotKey	CTRL+F - Invokes the Search Panel. Ensure that no cell editor is opened before invoking the Find Panel. Otherwise, the shortcut will be intercepted by the in-place editor. The Close button (if displayed) hides the Search Panel. ESC - Clears the search box. If the search box is empty, pressing ESC closes the Search Panel.
Always	The Search Panel is always visible, it cannot be hidden by an end-user. The close button is hidden.
Never	The Search Panel is hidden and cannot be shown by the end-user.

Remarks

By default, an end-user can show and hide the Search Panel when required. To display the Search Panel, an end-user should press CTRL+F or select ‘Show Search Panel’ item of a column’s context menu. To hide the Search Panel, an end-user should do one of the following: click the Close button (if visible), use ESC (the first press clears the search box; the second press closes the Search Panel) or select the ‘Hide Search Panel’ item of a column’s context menu.

To display the Search Panel within a View and prevent an end-user from hiding it, set the ShowSearchPanelMode property to ShowSearchPanelMode.Always. To hide the Search Panel and prevent an end-user from showing it, set the ShowSearchPanelMode property to ShowSearchPanelMode.Never.

Related GitHub Examples

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

C#

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

<dxg:TableView AllowPerPixelScrolling="True"
               ShowSearchPanelMode="Never"
               SearchPanelAllowFilter="False"

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>

how-to-bind-to-iqueryable/CS/MainWindow.xaml#L35

<dxg:TableView ColumnSortClearMode="Click"
               ShowSearchPanelMode="Always" SearchStringToFilterCriteria="OnSearchStringToFilterCriteria"
               ShowFixedTotalSummary="True"/>

how-to-bind-to-custom-service-with-restrictions/CS/MainWindow.xaml#L40

    <dxg:TableView CompactPanelShowMode="Always" CompactSortElementShowMode="Always"
                   ShowSearchPanelMode="Always" SearchStringToFilterCriteria="OnSearchStringToFilterCriteria"/>
</dxg:GridControl.View>

How-to-show-text-instead-of-checkboxes-in-boolean-columns-with-the-capability-to-search-by-this-text/CS/MainWindow.xaml#L38

<dxg:GridControl.View>
    <dxg:TableView AllowPerPixelScrolling="True" ShowTotalSummary="True" ShowSearchPanelMode="Always"/>
</dxg:GridControl.View>