SearchControl.QuerySearchParameters Event

Fires when the SearchControl‘s text is submitted. Handle the event to get or set the search text and condition.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event EventHandler<SearchControlQueryParamsEventArgs> QuerySearchParameters

VB.NET

<DXCategory("Events")>
Public Event QuerySearchParameters As EventHandler(Of SearchControlQueryParamsEventArgs)

Event Data

The QuerySearchParameters event's data class is DevExpress.Utils.SearchControlQueryParamsEventArgs.

Remarks

The QuerySearchParameters event provides access to the following properties:

• SearchText - to access the text in the SearchControl,
• FilterCondition - to modify the standard search condition.

Note that the FilterCondition property does not work in Data Grid controls, because they have their own filtering features.

The example below prevents search for queries under 3 symbols and matches the search text only to the target text’s beginning.

C#

private void searchControl1_QuerySearchParameters(object sender, 
    DevExpress.Utils.SearchControlQueryParamsEventArgs e) {
    e.FilterCondition = DevExpress.Data.Filtering.FilterCondition.StartsWith;
    if(e.SearchText.Length < 3) {
        e.SearchText = String.Empty;
    }
}

VB.NET

Private Sub searchControl1_QuerySearchParameters(ByVal sender As Object, _
    ByVal e As DevExpress.Utils.SearchControlQueryParamsEventArgs)
    e.FilterCondition = DevExpress.Data.Filtering.FilterCondition.StartsWith
    If e.SearchText.Length < 3 Then
        e.SearchText = String.Empty
    End If
End Sub

The image below demonstrates the result:

To limit search by column, you can subscribe to the SearchControl.QueryIsSearchColumn or RepositoryItemSearchControl.QueryIsSearchColumn event.