Back to Devexpress

OptionsColumnFilter.InHeaderSearchPrompt Property

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-optionscolumnfilter-773e067d.md

latest3.6 KB
Original Source

OptionsColumnFilter.InHeaderSearchPrompt Property

Gets or sets a grayed out hint displayed in an empty header search box when the search box is activated.

Namespace : DevExpress.XtraGrid.Columns

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
[DefaultValue("")]
[XtraSerializableProperty]
public virtual string InHeaderSearchPrompt { get; set; }
vb
<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property InHeaderSearchPrompt As String

Property Value

TypeDefaultDescription
StringString.Empty

A grayed out hint displayed in an empty header search box when the search box is activated.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to InHeaderSearchPrompt
GridColumn

.OptionsFilter .InHeaderSearchPrompt

|

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.

When a search box is activated, Data Grid displays a grayed out hint in the search box.

Use the InHeaderSearchPrompt property to set a custom hint.

csharp
colCountry.OptionsFilter.InHeaderSearchPrompt = "Find in column...";
vb
colCountry.OptionsFilter.InHeaderSearchPrompt = "Find in column..."

See Also

InHeaderSearchMode

AllowInHeaderSearch

ClearInHeaderSearchText

HideInHeaderSearchTextBox()

ShowInHeaderSearchTextBox(GridColumn)

SearchText

ShowInHeaderSearchTextMode

OptionsColumnFilter Class

OptionsColumnFilter Members

DevExpress.XtraGrid.Columns Namespace