GridColumn.Caption Property

Gets or sets the column’s display caption.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DXCategory("Appearance")]
[DefaultValue("")]
[XtraSerializableProperty]
public virtual string Caption { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the column’s display caption.

Remarks

In Grid Views, columns’ captions are displayed in column headers. In Card and Layout Views, captions identify individual card fields.

By default, the Caption property is set to an empty string. In this instance, a friendly caption is generated for a column based on its GridColumn.FieldName property. Friendly captions are generated adding SPACE characters between parts of the field name starting with uppercase letters. For example, if the field name is “CustomerName”, the display caption will be “Customer Name”. To override the default display caption, assign it to the Caption property.

In Layout Views, the actual display captions are generated according to the pattern specified by the LayoutView.FieldCaptionFormat property.

To return the actual captions in Layout Views, use the LayoutView.GetFieldCaption method, while in other Views, use the GridColumn.GetCaption method.

If the GridOptionsView.AllowHtmlDrawHeaders property is set to true, you can use HTML tags to format the GridColumn.Caption and GridBand.Caption. For detailed information, see HTML Text Formatting.

Example

The following example shows how to format the GridColumn.Caption using HTML tags. HTML formatting is enabled via the GridOptionsView.AllowHtmlDrawHeaders property. The image below shows the result:

C#

gridColumn1.Caption = "Delivery<br/><b>Date</b>";

gridView1.OptionsView.AllowHtmlDrawHeaders = true;
gridView1.Appearance.HeaderPanel.Options.UseTextOptions = true;
gridView1.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap;

VB.NET

gridColumn1.Caption = "Delivery<br/><b>Date</b>"

gridView1.OptionsView.AllowHtmlDrawHeaders = True
gridView1.Appearance.HeaderPanel.Options.UseTextOptions = True
gridView1.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap

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#

vote-app-t445500/CS/VoteApp/Map.cs#L59

if(IsCountyMode && MapMode != MapMode.StateCountyView) {
    colArea.Caption = (activeStateCounty == null ? "County" : activeStateCounty.Name);
    this.listVoteResultsBindingSource.DataSource = GenerateCountyResults();

vote-applications-t446758/CS/VoteApp/Map.cs#L58

if(IsCountyMode && MapMode != MapMode.StateCountyView) {
    colArea.Caption = (activeStateCounty == null ? "County" : activeStateCounty.Name);
    this.listVoteResultsBindingSource.DataSource = GenerateCountyResults();

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/CS/Sample/Form1.cs#L27

customGridControl1.DataSource = myUsers;
customGridColumn1.Caption = customGridColumn1.FieldName = "Name";
customGridColumn2.Caption = customGridColumn2.FieldName = "City";

reporting-winforms-convert-grid-to-report/CS/XtraReport1.cs#L27

if(gv.Columns[i].Visible && gv.Columns[i].GroupIndex < 0) {
    columnAL.Add(gv.Columns[i].Caption);
}

how-to-allow-end-users-to-customize-column-captions-in-the-gridview-e1302/CS/Q148401/ChangeCaptionDialog.cs#L20

this.column = column;
textBox1.Text = column.Caption;
Location = position;

VB.NET

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/VB/Sample/Form1.vb#L26

customGridColumn1.FieldName = "Name"
customGridColumn1.Caption = customGridColumn1.FieldName
customGridColumn2.FieldName = "City"

reporting-winforms-convert-grid-to-report/VB/XtraReport1.vb#L30

If gv.Columns(i).Visible AndAlso gv.Columns(i).GroupIndex < 0 Then
    columnAL.Add(gv.Columns(i).Caption)
End If

how-to-allow-end-users-to-customize-column-captions-in-the-gridview-e1302/VB/Q148401/ChangeCaptionDialog.vb#L23

Me.column = column
textBox1.Text = column.Caption
Location = position

how-to-create-a-report-based-on-bandedgridview-at-runtime-t192075/VB/XtraReport1.vb#L29

If gv.Columns(i).Visible AndAlso gv.Columns(i).GroupIndex < 0 Then
    columnAL.Add(gv.Columns(i).Caption)
End If

objectdatasource-how-to-provide-a-custom-parameter-editor-t246429/VB/CustomRepositoryItem/MyRepositoryItemsProvider.vb#L59

col1.VisibleIndex = 0
col1.Caption = My.Resources.MyRepositoryItemsProvider_GetRepositoryItem_First_Name