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.v21.1.dll

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

Declaration

C#

[DefaultValue("")]
[XtraSerializableProperty]
public virtual string InHeaderSearchPrompt { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property InHeaderSearchPrompt As String

Property Value

Type	Default	Description
String	String.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 Type	Path to InHeaderSearchPrompt
GridColumn	.OptionsFilter .InHeaderSearchPrompt
LayoutViewColumn	.OptionsFilter .InHeaderSearchPrompt
BandedGridColumn	.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.

C#

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

VB.NET

colCountry.OptionsFilter.InHeaderSearchPrompt = "Find in column..."