GridColumn.Name Property

Gets or sets the column name.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
[DefaultValue("")]
[XtraSerializableProperty]
[XtraSerializablePropertyId(-1)]
public virtual string Name { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue("")>
<XtraSerializableProperty>
<XtraSerializablePropertyId(-1)>
Public Overridable Property Name As String

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the column name.

Remarks

GridColumn objects are Component descendants, so they can be directly accessed in code using their names. Therefore, the Name property specifies the string that can be used in code to access the column.

You can also use the Name property to identify a column when handling column related events, etc. Refer to the Columns help topic for more information on identifying columns.

Note

When saving/restoring a View’s layout, ensure that column names are set to unique values. Take particular note of that if columns are created in code, column names are not initialized automatically and they must be set manually.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Name 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#

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/CS/WinFormsExample/Form1.cs#L40

if (!e.HitInfo.InRowCell) return;
if (!ContainsComment(e.HitInfo.Column.Name, gridView1.GetDataSourceRowIndex(e.HitInfo.RowHandle))) {
    DXMenuItem insertItem = new DXMenuItem("Insert Comment");

how-to-select-a-column-in-the-xtragrid-like-in-ms-excel-e635/CS/Form1.cs#L39

{
    if (selectedColumns.IndexOf(info.Column.Name, 0, selectedColumns.Count) == -1)
    {

how-to-enable-users-to-design-gridview-format-conditions-at-runtime-e3717/CS/GridViewFormatCondition/ExpressionConditionDesigner.cs#L28

{
    Text = String.Format("Expression condition for column: [{0}]", SourceGridColumn.Name);
    LoadCondititons();

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/CS/EditorStatusViaCustomDraw/Form1.cs#L24

private void gridView1_CustomDrawCell(object sender, DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs e) {
    if(e.Column.Name == "colCheckIndicator") {
        string text;

VB.NET

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/VB/WinFormsExample/Form1.vb#L44

End If
If Not ContainsComment(e.HitInfo.Column.Name, gridView1.GetDataSourceRowIndex(e.HitInfo.RowHandle)) Then
    Dim insertItem As New DXMenuItem("Insert Comment")

how-to-select-a-column-in-the-xtragrid-like-in-ms-excel-e635/VB/Form1.vb#L43

If info.InColumn Then
    If selectedColumns.IndexOf(info.Column.Name, 0, selectedColumns.Count) = -1 Then
        info.Column.AppearanceCell.BackColor = Color.Gold

how-to-enable-users-to-design-gridview-format-conditions-at-runtime-e3717/VB/GridViewFormatCondition/ExpressionConditionDesigner.vb#L42

Private Sub ExpressionConditionDesigner_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    Text = String.Format("Expression condition for column: [{0}]", SourceGridColumn.Name)
    LoadCondititons()

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/VB/EditorStatusViaCustomDraw/Form1.vb#L26

Private Sub gridView1_CustomDrawCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs) Handles gridView1.CustomDrawCell
    If e.Column.Name = "colCheckIndicator" Then
        Dim text As String