SearchStringToFilterCriteriaEventArgs.SearchString Property

Gets the search string entered in the Search.

Namespace: DevExpress.Xpf.Grid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

public string SearchString { get; }

VB.NET

Public ReadOnly Property SearchString As String

Property Value

Type	Description
String	The search string entered in the search panel.

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.

C#

how-to-bind-to-iqueryable/CS/MainWindow.xaml.cs#L59

void OnSearchStringToFilterCriteria(object sender, SearchStringToFilterCriteriaEventArgs e) {
    e.Filter = new FunctionOperator(FunctionOperatorType.StartsWith, new OperandProperty("Subject"), e.SearchString);
}

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

void OnSearchStringToFilterCriteria(object sender, SearchStringToFilterCriteriaEventArgs e) {
    if(!string.IsNullOrEmpty(e.SearchString))
        e.Filter = new BinaryOperator("Tags", e.SearchString.Trim().ToLower(), BinaryOperatorType.Equal);

how-to-search-a-string-with-spaces/CS/How to Search a String with Spaces/MainWindow.xaml.cs#L14

private void TableView_SearchStringToFilterCriteria(object sender, DevExpress.Xpf.Grid.SearchStringToFilterCriteriaEventArgs e) {
    e.Filter = CriteriaOperator.Parse(string.Format("Contains([Name], '{0}')", e.SearchString));
}

VB.NET

how-to-bind-to-iqueryable/VB/MainWindow.xaml.vb#L53

Private Sub OnSearchStringToFilterCriteria(ByVal sender As Object, ByVal e As SearchStringToFilterCriteriaEventArgs)
    e.Filter = New FunctionOperator(FunctionOperatorType.StartsWith, New OperandProperty("Subject"), e.SearchString)
End Sub

how-to-bind-to-custom-service-with-restrictions/VB/MainWindow.xaml.vb#L115

Private Sub OnSearchStringToFilterCriteria(ByVal sender As Object, ByVal e As SearchStringToFilterCriteriaEventArgs)
    If Not String.IsNullOrEmpty(e.SearchString) Then
        e.Filter = New BinaryOperator("Tags", e.SearchString.Trim().ToLower(), BinaryOperatorType.Equal)

how-to-search-a-string-with-spaces/VB/How to Search a String with Spaces/MainWindow.xaml.vb#L16

Private Sub TableView_SearchStringToFilterCriteria(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.SearchStringToFilterCriteriaEventArgs)
    e.Filter = CriteriaOperator.Parse(String.Format("Contains([Name], '{0}')", e.SearchString))
End Sub