GridMenuEventArgs Class

Provides data for the DataViewBase.ShowGridMenu event.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v21.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public class GridMenuEventArgs :
    RoutedEventArgs

VB.NET

Public Class GridMenuEventArgs
    Inherits RoutedEventArgs

Related API Members

GridMenuEventArgs is the data class for the following events:

• DataViewBase.ShowGridMenu

Remarks

To learn more, see Context Menus.

Example

The following example demonstrates how to customize the grid’s context menu at runtime. This sample removes the default Show Column Chooser menu item from the Column Context Menu and adds a custom item instead.

Handle the DataViewBase.ShowGridMenu event. In the event handler, change the GridMenuEventArgs.Customizations collection to modify the list of menu items. To remove a menu item with its link, use the RemoveBarItemAndLinkAction instance. To add a custom menu item, add a new BarButtonItem object to the GridMenuEventArgs.Customizations collection.

View Example

Window1.xaml

<dxg:GridControl.View>
    <dxg:TableView ShowGridMenu="TableView_ShowGridMenu" />
</dxg:GridControl.View>

Window1.xaml.cs

private void TableView_ShowGridMenu(object sender, GridMenuEventArgs e) {
    // Check whether this event was raised for a column's context menu.
    if (e.MenuType != GridMenuType.Column) return;

    // Remove the Column Chooser menu item.
    e.Customizations.Add(new RemoveBarItemAndLinkAction() { 
        ItemName = DefaultColumnMenuItemNames.ColumnChooser });

    // Create a custom menu item and add it to the context menu.
    BarButtonItem bi = new BarButtonItem();
    bi.Name = "customItem";
    bi.Content = "Custom Item";
    bi.ItemClick += new ItemClickEventHandler(customItem_ItemClick);
    e.Customizations.Add(bi);
}

private void customItem_ItemClick(object sender, ItemClickEventArgs e) {
    // Implement the custom action.
    // ...
}

Window1.xaml.vb

Private Sub TableView_ShowGridMenu(ByVal sender As Object, ByVal e As GridMenuEventArgs)
    ' Check whether this event was raised for a column's context menu.
    If e.MenuType <> GridMenuType.Column Then
        Return
    End If

    ' Remove the Column Chooser menu item.
    e.Customizations.Add(New RemoveBarItemAndLinkAction() _
    With {.ItemName = DefaultColumnMenuItemNames.ColumnChooser})

    ' Create a custom menu item and add it to the context menu.
    Dim bi As New BarButtonItem()
    bi.Name = "customItem"
    bi.Content = "Custom Item"
    AddHandler bi.ItemClick, AddressOf customItem_ItemClick
    e.Customizations.Add(bi)
End Sub

Private Sub customItem_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    ' Implement the custom action.
    ' ...
End Sub

Inheritance

Object

EventArgs

RoutedEventArgs

GridMenuEventArgs