TreeList.ApplyFindFilter(String) Method

Fills in the Find Panel with the specified query and applies it.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

public bool ApplyFindFilter(
    string filter
)

VB.NET

Public Function ApplyFindFilter(
    filter As String
) As Boolean

Parameters

Name	Type	Description
filter	String	A String value that specifies the query.

Returns

Type	Description
Boolean	true, if the specified query is successfully applied; otherwise, false.

Remarks

Use the ApplyFindFilter(String) and ClearFindFilter() methods to apply and discard a search/filter query in code. See Find Panel Syntax to learn how to build queries.

C#

// Specify a query.
treeList1.ApplyFindFilter("foo");

// Discard the query.
treeList1.ClearFindFilter();
// You can also pass an empty string
// to discard the query.
treeList1.ApplyFindFilter(String.Empty);

VB.NET

' Specify a query.
TreeList1.ApplyFindFilter("foo")

' Discard the query.
TreeList1.ClearFindFilter()
' You can also pass an empty string
' to discard the query.
TreeList1.ApplyFindFilter(String.Empty)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ApplyFindFilter(String) method.

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#

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/CS/E520.Module.Win/Controllers/WinFilterTreeListViewController.cs#L54

}
treeList.ApplyFindFilter(value);
// Alternatively, use the TreeList.ActiveFilterCriteria property

VB.NET

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/VB/E520.Module.Win/Controllers/WinFilterTreeListViewController.vb#L56

End If
treeList.ApplyFindFilter(value)
' Alternatively, use the TreeList.ActiveFilterCriteria property