SearchControl.QueryIsSearchColumn Event

Enables you to specify the attached object’s columns through which a search is performed.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Events")]
public event QueryIsSearchColumnEventHandler QueryIsSearchColumn

VB.NET

<DXCategory("Events")>
Public Event QueryIsSearchColumn As QueryIsSearchColumnEventHandler

Event Data

The QueryIsSearchColumn event's data class is DevExpress.XtraEditors.QueryIsSearchColumnEventArgs.

Remarks

The QueryIsSearchColumn event is equivalent to the SearchControl.Properties.QueryIsSearchColumn event.

Example

The code below shows how to enable the SearchControl to search only in the Ship Country column.

C#

private void searchControl1_QueryIsSearchColumn(object sender, DevExpress.XtraEditors.QueryIsSearchColumnEventArgs args) {
    // The sender parameter specifies the processed data field/column/row.
    // The actual type depends on the attached control.
    if (sender.ToString() != "Ship Country") args.IsSearchColumn = false;
}

VB.NET

Private Sub searchControl1_QueryIsSearchColumn(sender As Object, args As DevExpress.XtraEditors.QueryIsSearchColumnEventArgs)
    ' The sender parameter specifies the processed data field/column/row.
    ' The actual type depends on the attached control.
    If sender.ToString() <> "Ship Country" Then
        args.IsSearchColumn = False
    End If
End Sub

The figure below shows the grid filtered only against the Ship Country column.

The SearchControl.QueryIsSearchColumn event is equivalent to the SearchControl.Properties.QueryIsSearchColumn event.