Back to Devexpress

GridOptionsFilter.ShowInHeaderSearchTextMode Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridoptionsfilter-860f322c.md

latest4.4 KB
Original Source

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.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(ShowInHeaderSearchTextMode.Default)]
[XtraSerializableProperty]
public virtual ShowInHeaderSearchTextMode ShowInHeaderSearchTextMode { get; set; }
vb
<DefaultValue(ShowInHeaderSearchTextMode.Default)>
<XtraSerializableProperty>
Public Overridable Property ShowInHeaderSearchTextMode As ShowInHeaderSearchTextMode

Property Value

TypeDefaultDescription
ShowInHeaderSearchTextModeDefault

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

|

Available values:

NameDescription
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 TypePath 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.

See Also

InHeaderSearchMode

AllowInHeaderSearch

ClearInHeaderSearchText

HideInHeaderSearchTextBox()

ShowInHeaderSearchTextBox(GridColumn)

SearchText

InHeaderSearchPrompt

GridOptionsFilter Class

GridOptionsFilter Members

DevExpress.XtraGrid.Views.Grid Namespace