DataViewBase.SearchString Property

Gets or sets the search string specified within the Search Panel. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public string SearchString { get; set; }

VB.NET

Public Property SearchString As String

Property Value

Type	Description
String	A String value that specifies the search string.

Remarks

Tip

Topic: Search

A user specifies a search string in the Search Panel‘s edit box. Use the SearchString property to specify a search string in code.

Note

Searches performed with the Search Panel are case-insensitive.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SearchString 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-specify-nodes-filter-mode/CS/MainWindow.xaml#L21

    <dxg:TreeListView KeyFieldName="ID" ParentFieldName="ParentID" AutoExpandAllNodes="True" ShowSearchPanelMode="Always" AutoWidth="True"
                      FilteringMode="{Binding EditValue, ElementName=listBoxEdit}" SearchString="Manager" />
</dxg:GridControl.View>

C#

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/CS/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.cs#L180

protected void CloseExecute() {
    this._Grid.View.SearchString = string.Empty;
    this.Hide();

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

TableView view = sender as TableView;
view.SearchString = "Element2";
view.SelectCells(15, view.Grid.Columns[0], 25, view.Grid.Columns[1]);

VB.NET

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/VB/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.vb#L173

Protected Sub CloseExecute()
    _Grid.View.SearchString = String.Empty
    Hide()

how-to-use-scrollbar-annotations-t534664/VB/WpfApplication25/MainWindow.xaml.vb#L44

Dim view As DevExpress.Xpf.Grid.TableView = TryCast(sender, DevExpress.Xpf.Grid.TableView)
view.SearchString = "Element2"
view.SelectCells(15, view.Grid.Columns(0), 25, view.Grid.Columns(1))