ColumnView.FindFilterText Property

Gets or sets the query in the Find Panel.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[Browsable(false)]
[XtraSerializableProperty(1010)]
[XtraSerializablePropertyId(3)]
public string FindFilterText { get; set; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(1010)>
<XtraSerializablePropertyId(3)>
Public Property FindFilterText As String

Property Value

Type	Description
String	A String value that specifies the query in the Find Panel.

Remarks

Use the FindFilterText property to get the applied search/find query.

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.
gridView1.ApplyFindFilter("foo");

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

VB.NET

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

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FindFilterText 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-customize-the-default-find-panel-filtering-algorithm-e2801/CS/WindowsApplication1/Helper/FilterCriteriaHelper.cs#L38

{
    return ReplaceFilterCriteria(source, ConvertFindPanelTextToCriteriaOperator(view.FindFilterText, view, true), newOperand);
}

how-to-make-richedit-highlight-strings-that-match-the-find-panel-text-e4422/CS/E4422/Form1.cs#L24

private void OnCustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e) {
    if (e.Column == colDescription && !string.IsNullOrEmpty(gridView1.FindFilterText)) {
        server.RtfText = e.DisplayText;

how-to-change-colors-of-a-highlighted-text-corresponding-to-a-search-string-of-find-panel-e3260/CS/WindowsApplication3/Main.cs#L65

if(view.OptionsFind.HighlightFindResults && !view.FindFilterText.Equals(string.Empty)){
 CriteriaOperator op =   ConvertFindPanelTextToCriteriaOperator(view.FindFilterText, view,false);
 if (op is GroupOperator)

how-to-expand-visible-group-rows-when-the-user-searches-using-the-find-panel-e3903/CS/FindPanelExample/MainForm.cs#L31

void OnGridViewRowCountChanged(object sender, EventArgs e) {
    if (string.IsNullOrEmpty(GridView.FindFilterText)) return;
    BeginInvoke(new MethodInvoker(ExpandVisibleRows));

how-to-hide-master-view-rows-if-their-child-rows-are-totally-filtered-out-in-the-child-view-e3747/CS/E3747CS/FilterHelper.cs#L39

}
if(view.FindFilterText == string.Empty) {
    ExpressionEvaluator ev = new ExpressionEvaluator(pdc, controller.FilterCriteria);

VB.NET

how-to-customize-the-default-find-panel-filtering-algorithm-e2801/VB/Helper/FilterCriteriaHelper.vb#L39

Public Shared Function ReplaceFindPanelCriteria(ByVal source As CriteriaOperator, ByVal view As GridView, ByVal newOperand As CriteriaOperator) As CriteriaOperator
    Return ReplaceFilterCriteria(source, ConvertFindPanelTextToCriteriaOperator(view.FindFilterText, view, True), newOperand)
End Function

how-to-make-richedit-highlight-strings-that-match-the-find-panel-text-e4422/VB/E4422/Form1.vb#L26

Private Sub OnCustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs)
    If e.Column Is colDescription AndAlso (Not String.IsNullOrEmpty(gridView1.FindFilterText)) Then
        server.RtfText = e.DisplayText

how-to-change-colors-of-a-highlighted-text-corresponding-to-a-search-string-of-find-panel-e3260/VB/WindowsApplication3/Main.vb#L62

If view.OptionsFind.HighlightFindResults AndAlso (Not view.FindFilterText.Equals(String.Empty)) Then
 Dim op As CriteriaOperator = ConvertFindPanelTextToCriteriaOperator(view.FindFilterText, view,False)
 If TypeOf op Is GroupOperator Then

how-to-expand-visible-group-rows-when-the-user-searches-using-the-find-panel-e3903/VB/FindPanelExample/MainForm.vb#L38

Private Sub OnGridViewRowCountChanged(ByVal sender As Object, ByVal e As EventArgs) Handles GridView.RowCountChanged
    If String.IsNullOrEmpty(GridView.FindFilterText) Then
        Return

how-to-hide-master-view-rows-if-their-child-rows-are-totally-filtered-out-in-the-child-view-e3747/VB/E3747CS/FilterHelper.vb#L32

End If
If view.FindFilterText = String.Empty Then
    Dim ev As New ExpressionEvaluator(pdc, controller.FilterCriteria)