All docs
V21.1
21.2 (EAP/Beta)
21.1
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

OptionsColumnFilter.AllowInHeaderSearch Property

Gets or sets whether a search box is enabled in the current column’s header. This property is in effect if the GridOptionsFilter.InHeaderSearchMode option is set to TextFilter.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v21.1.dll

Declaration

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public virtual DefaultBoolean AllowInHeaderSearch { get; set; }

Property Value

Type Default Description
DefaultBoolean

Default

A value that specifies whether a search box is enabled in the current column’s header.

Available values:

Name Description
True

Corresponds to a Boolean value of true.

False

Corresponds to a Boolean value of false.

Default

The default behavior determined by the control’s logic.

Property Paths

You can access this nested property as listed below:

Object Type Path to AllowInHeaderSearch
GridColumn
.OptionsFilter.AllowInHeaderSearch
LayoutViewColumn
.OptionsFilter.AllowInHeaderSearch
BandedGridColumn
.OptionsFilter.AllowInHeaderSearch

Remarks

Set the GridView.OptionsFilter.InHeaderSearchMode property to TextFilter to enable built-in search boxes within the View’s column headers. Users can type text in the search boxes to filter against the columns.

Data Grid - In-header search box

The GridColumn.OptionsFilter.AllowInHeaderSearch property allows you to disable header search boxes for individual columns.

The following example enables search boxes for all grid columns except the colOrderID column:

gridView1.OptionsFilter.InHeaderSearchMode = GridInHeaderSearchMode.TextFilter;
colOrderID.OptionsFilter.AllowInHeaderSearch = DevExpress.Utils.DefaultBoolean.False;

To disable search boxes in all columns except for specific columns, do the following:

A column’s header search box is disabled if the AllowInHeaderSearch property is set to Default or True, and the GridView.OptionsFilter.InHeaderSearchMode property is set to Default or Disabled.

See Also