WebColumnBase.Caption Property

SECURITY NOTE

Setting this property to values from an untrusted source may introduce security-related issues, since the property value is not encoded and is rendered as HTML markup. Call the HttpUtility.HtmlEncode method to encode the value.

Review the following help topic to better protect websites from cross-site scripting (XSS) attacks: HTML Encoding.

Gets or sets the text displayed within the column header.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

[DefaultValue("")]
public string Caption { get; set; }

VB.NET

<DefaultValue("")>
Public Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the text displayed within the column’s header.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-web-forms-grid-add-numbers-to-rows/CS/Default.aspx.cs#L5

protected void ASPxGridView1_CustomColumnDisplayText(object sender, DevExpress.Web.ASPxGridViewColumnDisplayTextEventArgs e) {
    if (e.Column.Caption == "#") {
        e.DisplayText = e.VisibleRowIndex.ToString();

aspxgridview-dataitemtemplate-runtime/CS/HyperlinkColumn/Default.aspx.cs#L48

colItemTemplate.Name = "colItemTemplate";
colItemTemplate.Caption = "Template Column";
ASPxGridView1.Columns.Add(colItemTemplate);

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Models/MVCxGridViewState.cs#L43

public GridViewDataColumnState(GridViewDataColumn column) {
    Caption = column.Caption;
    FieldName = column.FieldName;

asp-net-web-forms-grid-create-report-based-on-grid-layout/CS/WebApplication1/ReportHelper.cs#L197

foreach(GridViewDataColumn dataColumn in visibleColumns) {
    ColumnInfo column = new ColumnInfo(dataColumn) { ColumnCaption = string.IsNullOrEmpty(dataColumn.Caption) ? dataColumn.FieldName : dataColumn.Caption, ColumnWidth = ((int)pagewidth / visibleColumns.Count), FieldName = dataColumn.FieldName, IsVisible = true };
    columns.Add(column);

VB.NET

asp-net-web-forms-grid-add-numbers-to-rows/VB/Default.aspx.vb#L7

Protected Sub ASPxGridView1_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridViewColumnDisplayTextEventArgs)
    If Equals(e.Column.Caption, "#") Then
        e.DisplayText = e.VisibleRowIndex.ToString()

aspxgridview-dataitemtemplate-runtime/VB/HyperlinkColumn/Default.aspx.vb#L43

colItemTemplate.Name = "colItemTemplate"
colItemTemplate.Caption = "Template Column"
ASPxGridView1.Columns.Add(colItemTemplate)

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Models/MVCxGridViewState.vb#L120

Public Sub New(ByVal column As GridViewDataColumn)
    Caption = column.Caption
    FieldName = column.FieldName

asp-net-web-forms-grid-create-report-based-on-grid-layout/VB/WebApplication1/ReportHelper.vb#L203

Dim column As New ColumnInfo(dataColumn) With {
    .ColumnCaption = If(String.IsNullOrEmpty(dataColumn.Caption), dataColumn.FieldName, dataColumn.Caption),
    .ColumnWidth = (CInt(pagewidth) \ visibleColumns.Count),