GridMenuEventArgs Class

Provides data for the DataViewBase.ShowGridMenu event.

Namespace: DevExpress.Xpf.Grid

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

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. For instance this sample demonstrates how to remove the default ‘Show Column Chooser’ menu item from the Column Context Menu, and add a custom item instead.

For this, it is necessary to handle the DataViewBase.ShowGridMenu event. In the event handler, all modifications to the list of menu items can be done by changing the GridMenuEventArgs.Customizations collection. To remove a specific menu item along with its link, use the RemoveBarItemAndLinkAction instance, and to add a custom menu item, a new BarButtonItem object must be added to the e.Customizations collection.

Note

A complete sample project is available at: https://github.com/DevExpress-Examples/how-to-modify-the-context-menu-of-grid-columns-e1837

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GridMenuEventArgs class.

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-add-a-custom-button-to-a-column-header-e1838/CS/Window1.xaml.cs#L14

#region #events
private void TableView_ShowGridMenu(object sender, GridMenuEventArgs e) {
    // Check whether this event was raised for a column's context menu.

how-to-modify-the-context-menu-of-grid-columns-e1837/CS/Window1.xaml.cs#L13

#region #ShowGridMenu
 private void TableView_ShowGridMenu(object sender, GridMenuEventArgs e) {
     // Check whether this event was raised for a column's context menu.

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/CS/Default MVVM/MainWindow.xaml.cs#L34

void OnShowGridMenu(object sender, GridMenuEventArgs e)
{

VB.NET

how-to-add-a-custom-button-to-a-column-header-e1838/VB/Window1.xaml.vb#L16

#Region "#events"
Private Sub TableView_ShowGridMenu(ByVal sender As Object, ByVal e As GridMenuEventArgs)
    ' Check whether this event was raised for a column's context menu.

how-to-modify-the-context-menu-of-grid-columns-e1837/VB/Window1.xaml.vb#L15

#Region "#ShowGridMenu"
Private Sub TableView_ShowGridMenu(ByVal sender As Object, ByVal e As GridMenuEventArgs)
    ' Check whether this event was raised for a column's context menu.

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/VB/Default MVVM/MainWindow.xaml.vb#L33

Private Sub OnShowGridMenu(ByVal sender As Object, ByVal e As GridMenuEventArgs)
    If e.MenuType = GridMenuType.Column Then

Inheritance

Object

EventArgs

RoutedEventArgs

GridMenuEventArgs