DXMenuItem.Tag Property

Gets or sets the data associated with the menu item.

Namespace: DevExpress.Utils.Menu

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public object Tag { get; set; }

VB.NET

Public Property Tag As Object

Property Value

Type	Description
Object	An object that contains the information which is associated with the menu item.

Remarks

You can use the Tag property to associate any data with a menu item and then use this data for instance in a DXMenuItem.Click event handler.

Example

The following example shows how to use the GridView.PopupMenuShowing event to create a custom menu in the Data Grid control. The created menu is displayed when you right-click within a data row or group row. It contains a ‘Rows’ submenu with a single “Delete this row” regular button, and a ‘Cell Merging’ check button.

A click on the ‘Delete this row’ button invokes the ColumnView.DeleteRow method. The ‘Cell Merging’ check button toggles the GridOptionsView.AllowCellMerge option.

C#

using DevExpress.XtraGrid.Views.Grid;
using DevExpress.Utils.Menu;
using DevExpress.XtraEditors;

private void gridView1_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    GridView view = sender as GridView;
    if (e.MenuType == DevExpress.XtraGrid.Views.Grid.GridMenuType.Row) {
        int rowHandle = e.HitInfo.RowHandle;
        // Delete existing menu items, if any.
        e.Menu.Items.Clear();
        // Add the Rows submenu with the 'Delete Row' command
        e.Menu.Items.Add(CreateSubMenuRows(view, rowHandle));
        // Add the 'Cell Merging' check menu item.
        DXMenuItem item = CreateMenuItemCellMerging(view, rowHandle);
        item.BeginGroup = true;
        e.Menu.Items.Add(item);
    }
}

DXMenuItem CreateSubMenuRows(GridView view, int rowHandle) {
    DXSubMenuItem subMenu = new DXSubMenuItem("Rows");
    string deleteRowsCommandCaption;
    if (view.IsGroupRow(rowHandle))
        deleteRowsCommandCaption = "&Delete rows in this group";
    else
        deleteRowsCommandCaption = "&Delete this row";
    DXMenuItem menuItemDeleteRow = new DXMenuItem(deleteRowsCommandCaption, new EventHandler(OnDeleteRowClick), imageCollection1.Images[0]);
    menuItemDeleteRow.Tag = new RowInfo(view, rowHandle);
    menuItemDeleteRow.Enabled = view.IsDataRow(rowHandle) || view.IsGroupRow(rowHandle);
    subMenu.Items.Add(menuItemDeleteRow);
    return subMenu;
}

DXMenuCheckItem CreateMenuItemCellMerging(GridView view, int rowHandle) {
    DXMenuCheckItem checkItem = new DXMenuCheckItem("Cell &Merging",
      view.OptionsView.AllowCellMerge, null, new EventHandler(OnCellMergingClick));
    checkItem.Tag = new RowInfo(view, rowHandle);
    checkItem.ImageOptions.Image = imageCollection1.Images[1];
    return checkItem;
}

void OnDeleteRowClick(object sender, EventArgs e) {
    DXMenuItem menuItem = sender as DXMenuItem;
    RowInfo ri = menuItem.Tag as RowInfo;
    if (ri != null) {
        string message = menuItem.Caption.Replace("&", "");
        if (XtraMessageBox.Show(message + " ?", "Confirm operation", MessageBoxButtons.YesNo) != DialogResult.Yes)
            return;
        ri.View.DeleteRow(ri.RowHandle);
    }
}

void OnCellMergingClick(object sender, EventArgs e) {
    DXMenuCheckItem item = sender as DXMenuCheckItem;
    RowInfo info = item.Tag as RowInfo;
    info.View.OptionsView.AllowCellMerge = item.Checked;
}

class RowInfo {
    public RowInfo(GridView view, int rowHandle) {
        this.RowHandle = rowHandle;
        this.View = view;
    }
    public GridView View;
    public int RowHandle;
}

VB.NET

Imports DevExpress.Utils.Menu
Imports DevExpress.XtraEditors
Imports DevExpress.XtraGrid.Views.Grid

Private Sub GridView1_PopupMenuShowing(sender As Object, e As PopupMenuShowingEventArgs) Handles GridView1.PopupMenuShowing
    Dim view As GridView = TryCast(sender, GridView)

    If e.MenuType = GridMenuType.Row Then
        Dim rowHandle As Integer = e.HitInfo.RowHandle
        e.Menu.Items.Clear()
        e.Menu.Items.Add(CreateSubMenuRows(view, rowHandle))
        Dim item As DXMenuItem = CreateMenuItemCellMerging(view, rowHandle)
        item.BeginGroup = True
        e.Menu.Items.Add(item)
    End If
End Sub

Private Function CreateSubMenuRows(ByVal view As GridView, ByVal rowHandle As Integer) As DXMenuItem
    Dim subMenu As DXSubMenuItem = New DXSubMenuItem("Rows")
    Dim deleteRowsCommandCaption As String
    If view.IsGroupRow(rowHandle) Then
        deleteRowsCommandCaption = "&Delete rows in this group"
    Else
        deleteRowsCommandCaption = "&Delete this row"
    End If
    Dim menuItemDeleteRow As DXMenuItem = New DXMenuItem(deleteRowsCommandCaption, New EventHandler(AddressOf OnDeleteRowClick), ImageCollection1.Images(0))
    menuItemDeleteRow.Tag = New RowInfo(view, rowHandle)
    menuItemDeleteRow.Enabled = view.IsDataRow(rowHandle) OrElse view.IsGroupRow(rowHandle)
    subMenu.Items.Add(menuItemDeleteRow)
    Return subMenu
End Function

Private Function CreateMenuItemCellMerging(ByVal view As GridView, ByVal rowHandle As Integer) As DXMenuCheckItem
    Dim checkItem As DXMenuCheckItem = New DXMenuCheckItem("Cell &Merging", view.OptionsView.AllowCellMerge, Nothing, New EventHandler(AddressOf OnCellMergingClick))
    checkItem.Tag = New RowInfo(view, rowHandle)
    checkItem.ImageOptions.Image = ImageCollection1.Images(1)
    Return checkItem
End Function

Private Sub OnDeleteRowClick(ByVal sender As Object, ByVal e As EventArgs)
    Dim menuItem As DXMenuItem = TryCast(sender, DXMenuItem)
    Dim ri As RowInfo = TryCast(menuItem.Tag, RowInfo)
    If ri IsNot Nothing Then
        Dim message As String = menuItem.Caption.Replace("&", "")
        If XtraMessageBox.Show(message & " ?", "Confirm operation", MessageBoxButtons.YesNo) <> DialogResult.Yes Then Return
        ri.View.DeleteRow(ri.RowHandle)
    End If
End Sub

Private Sub OnCellMergingClick(ByVal sender As Object, ByVal e As EventArgs)
    Dim item As DXMenuCheckItem = TryCast(sender, DXMenuCheckItem)
    Dim info As RowInfo = TryCast(item.Tag, RowInfo)
    info.View.OptionsView.AllowCellMerge = item.Checked
End Sub

Class RowInfo
    Public Sub New(ByVal view As GridView, ByVal rowHandle As Integer)
        Me.RowHandle = rowHandle
        Me.View = view
    End Sub

    Public View As GridView
    Public RowHandle As Integer
End Class

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#

shows-how-to-add-the-bookmark-functionality-e1267/CS/E1267/GridViewBookmarks.cs#L88

item.Click += eventHandler;
item.Tag = i;
item.Checked = BookMarks[i] != null;

how-to-implement-a-custom-sort-by-summary-feature-e2917/CS/WindowsApplication53/Form1.cs#L58

foreach (DXMenuItem item in e.Menu.Items) {
    PivotGridFieldPair pair = item.Tag as PivotGridFieldPair;
    if (pair != null) {

how-to-extend-the-layoutcontrols-context-menu-to-set-an-image-for-a-layout-item-e2426/CS/WindowsApplication3/Form1.cs#L32

DXMenuItem item = new DXMenuItem(caption, handler, img);
item.Tag = layoutItem;
return item;

how-to-display-a-limited-number-of-child-rows-in-an-expanded-group-in-gridview-t495343/CS/DXApplication3/GroupHelper.cs#L54

    new DXMenuItem("Show less child rows", showLess_Click);
menuItem.Tag = rowHandle;
e.Menu.Items.Add(menuItem);

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

e.Menu.Items.Add(insertItem);
insertItem.Tag = e.Point;
insertItem.Click += new EventHandler(insertItem_Click);

VB.NET

shows-how-to-add-the-bookmark-functionality-e1267/VB/E1267/GridViewBookmarks.vb#L110

AddHandler item.Click, eventHandler
item.Tag = i
item.Checked = BookMarks(i) IsNot Nothing

how-to-implement-a-custom-sort-by-summary-feature-e2917/VB/WindowsApplication53/Form1.vb#L62

For Each item As DXMenuItem In e.Menu.Items
    Dim pair As PivotGridFieldPair = TryCast(item.Tag, PivotGridFieldPair)
    If pair IsNot Nothing Then

how-to-extend-the-layoutcontrols-context-menu-to-set-an-image-for-a-layout-item-e2426/VB/WindowsApplication3/Form1.vb#L36

Dim item As New DXMenuItem(caption, handler, img)
item.Tag = layoutItem
Return item

how-to-display-a-limited-number-of-child-rows-in-an-expanded-group-in-gridview-t495343/VB/DXApplication3/GroupHelper.vb#L53

Dim menuItem = If(groupRows.ContainsKey(rowHandle), New DXMenuItem("Show all child rows", AddressOf showAll_Click), New DXMenuItem("Show less child rows", AddressOf showLess_Click))
menuItem.Tag = rowHandle
e.Menu.Items.Add(menuItem)

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

e.Menu.Items.Add(insertItem)
insertItem.Tag = e.Point
AddHandler insertItem.Click, AddressOf insertItem_Click