QueryIsSearchColumnEventArgs Class

Contains data for the SearchControl.QueryIsSearchColumn and RepositoryItemSearchControl.QueryIsSearchColumn events.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public class QueryIsSearchColumnEventArgs :
    EventArgs

VB.NET

Public Class QueryIsSearchColumnEventArgs
    Inherits EventArgs

Related API Members

QueryIsSearchColumnEventArgs is the data class for the following events:

• RepositoryItemSearchControl.QueryIsSearchColumn
• SearchControl.QueryIsSearchColumn

Remarks

The SearchControl searches through all columns in the attached control (see RepositoryItemSearchControl.Client).

The QueryIsSearchColumn event allows you to specify whether or not to search in a specific column. The control raises this event for each column in the attached control. Read the Caption event argument to obtain the processed column’s caption. You can also use the FieldName and DataType arguments to obtain the processed field’s name and data type. If the SearchControl should not be permitted to search in the processed column, set the IsSearchColumn event argument to false.

The SearchControl.QueryIsSearchColumn and RepositoryItemSearchControl.QueryIsSearchColumn (see SearchControl.Properties) events are equivalent.

Example

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

C#

using DevExpress.XtraEditors;

private void searchControl1_QueryIsSearchColumn(object sender, QueryIsSearchColumnEventArgs args) {
    if (args.FieldName != "ShipCountry")
        args.IsSearchColumn = false;    
}

VB.NET

Imports DevExpress.XtraEditors

Private Sub SearchControl1_QueryIsSearchColumn(sender As Object, args As QueryIsSearchColumnEventArgs) _
    Handles SearchControl1.QueryIsSearchColumn
    If args.FieldName <> "ShipCountry" Then
        args.IsSearchColumn = False
    End If
End Sub

Inheritance

Object

EventArgs

QueryIsSearchColumnEventArgs