GridColumn.SearchText Property

Gets or sets the text of the column’s built-in header search box. This property is supported in Grid Views and Banded Grid Views.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.1.dll

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

Declaration

C#

[DefaultValue("")]
[DXCategory("Data")]
[XtraSerializableProperty]
[XtraSerializablePropertyId(2)]
public string SearchText { get; set; }

VB.NET

<DefaultValue("")>
<DXCategory("Data")>
<XtraSerializablePropertyId(2)>
<XtraSerializableProperty>
Public Property SearchText As String

Property Value

Type	Default	Description
String	String.Empty	The text of the built-in header search box.

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.

The SearchText property specifies the text of the column’s header search box.

C#

colProductName.SearchText = "tofu";

VB.NET

colProductName.SearchText = "tofu"

Set the SearchText property to an empty string, or call the GridView.ClearInHeaderSearchText method to clear the search text.

See the following topic for more information: GridView.OptionsFilter.InHeaderSearchMode.