GridColumn.GetCaption() Method

Returns the actual display caption for the current column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public virtual string GetCaption()

VB.NET

Public Overridable Function GetCaption As String

Returns

Type	Description
String	A string that specifies the column’s actual display caption.

Remarks

If the GridColumn.Caption property is set to an empty string, a friendly display caption is automatically generated according to the GridColumn.FieldName property. Use the GetCaption method to return the actual display caption. To get the actual display caption in Layout Views, use the LayoutView.GetFieldCaption method.

See GridColumn.Caption to learn more.

Related GitHub Examples

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

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#

building-a-simple-expense-tracking-application-using-xtragrid-for-winforms-example-solution-e5063/CS/XtraGridTutorial.Step4/MainForm.cs#L66

    e.Valid = false;
    transactionsGridView.SetColumnError(colTrasactionDate, ValidationErrorStringsHelper.GetDateErrorMessage(colTrasactionDate.GetCaption()));
}

winforms-grid-double-click-row-cell/CS/DoubleClickCell/Form1.cs#L27

if(info.InRow || info.InRowCell) {
    string colCaption = info.Column == null ? "N/A" : info.Column.GetCaption();
    MessageBox.Show(string.Format("DoubleClick on row: {0}, column: {1}.", info.RowHandle, colCaption));

how-to-show-the-textedit-within-a-columns-header-to-allow-end-users-to-change-the-columns-ca-e1966/CS/WindowsApplication1/MyGridColumnRenameHelper.cs#L79

headerEdit.SetBounds(bounds.X, bounds.Y, bounds.Width, bounds.Height);
headerEdit.EditValue = column.GetCaption();
headerEdit.Show();

how-to-implement-adaptive-column-captions-t238464/CS/DevExpress.AutoNarrowColumnsCaptionsFeature/ColumnCaptionHelper/ColumnCaptionHelper.cs#L107

    GridColumn column = View.Columns[i];
    captions.Add(new CaptionItem() { FieldName = column.FieldName, Captions = column.GetCaption() + SEPARATOR_STRING });
}

XDL_how-to-delete-all-criteria-corresponding-to-a-particular-field-from-criteriaoperator-e3396/CS/WindowsApplication3/Main.cs#L30

    foreach (GridColumn col in gridView1.Columns)
        radioGroup1.Properties.Items.Add(new DevExpress.XtraEditors.Controls.RadioGroupItem(col.FieldName, col.GetCaption()));
}

VB.NET

building-a-simple-expense-tracking-application-using-xtragrid-for-winforms-example-solution-e5063/VB/XtraGridTutorial.Step4/MainForm.vb#L61

    e.Valid = False
    transactionsGridView.SetColumnError(colTrasactionDate, ValidationErrorStringsHelper.GetDateErrorMessage(colTrasactionDate.GetCaption()))
End If

winforms-grid-double-click-row-cell/VB/DoubleClickCell/Form1.vb#L28

If info.InRow OrElse info.InRowCell Then
    Dim colCaption As String = If(info.Column Is Nothing, "N/A", info.Column.GetCaption())
    MessageBox.Show(String.Format("DoubleClick on row: {0}, column: {1}.", info.RowHandle, colCaption))

how-to-show-the-textedit-within-a-columns-header-to-allow-end-users-to-change-the-columns-ca-e1966/VB/WindowsApplication1/MyGridColumnRenameHelper.vb#L75

headerEdit.SetBounds(bounds.X, bounds.Y, bounds.Width, bounds.Height)
headerEdit.EditValue = column.GetCaption()
headerEdit.Show()

how-to-implement-adaptive-column-captions-t238464/VB/DevExpress.AutoNarrowColumnsCaptionsFeature/ColumnCaptionHelper/ColumnCaptionHelper.vb#L117

    Dim column As GridColumn = View.Columns(i)
    captions.Add(New CaptionItem() With {.FieldName = column.FieldName, .Captions = column.GetCaption() & SEPARATOR_STRING})
Next i

XDL_how-to-delete-all-criteria-corresponding-to-a-particular-field-from-criteriaoperator-e3396/VB/WindowsApplication3/Main.vb#L31

For Each col As GridColumn In gridView1.Columns
    radioGroup1.Properties.Items.Add(New DevExpress.XtraEditors.Controls.RadioGroupItem(col.FieldName, col.GetCaption()))
Next col