GridSummaryItem.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 data associated with the summary item.

Namespace: DevExpress.XtraGrid

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

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

Property Value

Type	Default	Description
Object	null	An object containing information associated with the summary item.

Remarks

This property can be used to store any object that you want to associate with a summary item. 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 value. The dialog enables you to choose the data type and enter the desired value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-customize-footer-menu-calculate-custom-totals/CS/Form1.cs#L52

DevExpress.XtraGrid.Menu.GridViewFooterMenu footerMenu = e.Menu as DevExpress.XtraGrid.Menu.GridViewFooterMenu;
bool check = e.HitInfo.Column.SummaryItem.SummaryType == DevExpress.Data.SummaryItemType.Custom && Equals("Count", e.HitInfo.Column.SummaryItem.Tag);
DevExpress.Utils.Menu.DXMenuItem menuItem = new DevExpress.Utils.Menu.DXMenuCheckItem("Active Count", check, null, new EventHandler(MyMenuItem));

VB.NET

winforms-grid-customize-footer-menu-calculate-custom-totals/VB/Form1.vb#L45

Dim footerMenu As DevExpress.XtraGrid.Menu.GridViewFooterMenu = TryCast(e.Menu, DevExpress.XtraGrid.Menu.GridViewFooterMenu)
Dim check As Boolean = e.HitInfo.Column.SummaryItem.SummaryType = DevExpress.Data.SummaryItemType.Custom AndAlso Equals("Count", e.HitInfo.Column.SummaryItem.Tag)
Dim menuItem As DevExpress.Utils.Menu.DXMenuItem = New DevExpress.Utils.Menu.DXMenuCheckItem("Active Count", check, Nothing, New EventHandler(AddressOf MyMenuItem))