GridOptionsFilter.ShowInHeaderSearchTextMode Property

Gets or sets whether to show search text (GridColumn.SearchText) in column header tooltips. This property is in effect if built-in column header search boxes are enabled (see GridView.OptionsFilter.InHeaderSearchMode).

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

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

VB.NET

<DefaultValue(ShowInHeaderSearchTextMode.Default)>
<XtraSerializableProperty>
Public Overridable Property ShowInHeaderSearchTextMode As ShowInHeaderSearchTextMode

Property Value

Type	Default	Description
ShowInHeaderSearchTextMode	Default	A value that specifies whether to show search text (GridColumn.SearchText) in column header tooltips.

Available values:

Name	Description
Default	Equivalent to the Text option.
Text	A column header tooltip contains the hovered column’s caption. In this mode, the tooltip is only displayed if the column caption is truncated.
Tooltip	A column header tooltip contains the column caption and search text (GridColumn.SearchText).

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowInHeaderSearchTextMode
GridView	.OptionsFilter .ShowInHeaderSearchTextMode

Remarks

Use the GridView.OptionsFilter.InHeaderSearchMode property 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.

Set the ShowInHeaderSearchTextMode property to Tooltip to display a column’s search text (GridColumn.SearchText) in the column header’s tooltip.