GridColumn.Tag Property

SECURITY NOTE

Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization.

Gets or sets the data associated with the column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

<DXCategory("Data")>
<DefaultValue(Nothing)>
<XtraSerializableProperty>
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#

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);

VB.NET

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)