GridColumn.Tag Property

Gets or sets the data associated with the column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[DXCategory("Data")]
[DefaultValue(null)]
public virtual object Tag { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue(Nothing)>
Public Overridable Property Tag As Object

Property Value

Type	Default	Description
Object	*null*	An object containing information which is associated with the column.

Remarks

This property can be used to store any object that you want to associate with a column. Any type derived from the Object class can be assigned to this property via code. At design time, a specially designed dialog is used to set this property’s value. This dialog enables you to choose the data type and enter the desired value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Tag 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-create-custom-column-chooser-allowing-column-multi-select-without-checkboxes-e2783/CS/MultiSelectColumnCustomization/MultiSelectColumnCustomizationListBox.cs#L26

if (index == pushedIndex)
    ((GridColumn)Items[index]).Tag = 2;
else

winforms-grid-add-check-box-to-column-header/CS/GridViewColumnHeaderExtender.cs#L96

CheckColumnTag(column);
ColumnStateRepository temp = (col.Tag as ColumnStateRepository);
temp.Checked = !temp.Checked;

winforms-grid-custom-button-in-column-header/CS/WindowsApplication3/ColumnHeaderExtender.cs#L84

private void SetButtonState(GridColumn column, ObjectState state) {
    column.Tag = state;
    view.InvalidateColumnHeader(column);

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/CS/MyGridView.cs#L24

{
    if (column.Tag != null && Object.Equals(column.Tag, InvalidRowHandle))
        return true;

how-to-display-values-from-different-tables-in-the-same-gridview-e2665/CS/Form1.cs#L50

{
    DataColumn column = e.Column.Tag as DataColumn;
    if (e.IsGetData)

VB.NET

how-to-create-custom-column-chooser-allowing-column-multi-select-without-checkboxes-e2783/VB/MultiSelectColumnCustomization/MultiSelectColumnCustomizationListBox.vb#L24

If index = pushedIndex Then
    CType(Items(index), GridColumn).Tag = 2
Else

winforms-grid-add-check-box-to-column-header/VB/GridViewColumnHeaderExtender.vb#L97

CheckColumnTag(column)
Dim temp As ColumnStateRepository = (TryCast(col.Tag, ColumnStateRepository))
temp.Checked = Not temp.Checked

winforms-grid-custom-button-in-column-header/VB/WindowsApplication3/ColumnHeaderExtender.vb#L91

Private Sub SetButtonState(ByVal column As GridColumn, ByVal state As ObjectState)
    column.Tag = state
    view.InvalidateColumnHeader(column)

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/VB/MyGridView.vb#L32

Public Overrides Function CanSortColumn(ByVal column As GridColumn) As Boolean
    If column.Tag IsNot Nothing AndAlso Object.Equals(column.Tag, InvalidRowHandle) Then
        Return True

how-to-display-values-from-different-tables-in-the-same-gridview-e2665/VB/Form1.vb#L46

Private Sub gridView1_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs)
    Dim column As DataColumn = TryCast(e.Column.Tag, DataColumn)
    If e.IsGetData Then