SearchControl.QueryIsSearchColumn Event
Allows you to specify columns in the attached data control where the SearchControl should search for data.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
Event Data
The QueryIsSearchColumn event's data class is QueryIsSearchColumnEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Caption | Gets the processed column’s caption. |
| DataType | Gets the processed field’s data type. |
| FieldName | Gets the processed field’s name. |
| IsSearchColumn | Gets or sets whether to search in the processed column. |
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.
using DevExpress.XtraEditors;
private void searchControl1_QueryIsSearchColumn(object sender, QueryIsSearchColumnEventArgs args) {
if (args.FieldName != "ShipCountry")
args.IsSearchColumn = false;
}