You are viewing help content for pre-release software. This document and the features it describes are subject to change. Switch to the current version.

GridMenuEventArgs Class

Provides data for the DataViewBase.ShowGridMenu event.

Namespace: DevExpress.Xpf.Grid

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

Declaration

public class GridMenuEventArgs :
    RoutedEventArgs
Public Class GridMenuEventArgs
    Inherits RoutedEventArgs

Remarks

To learn more, see Context Menus.

Examples

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

<dxg:GridControl.View>
    <dxg:TableView ShowGridMenu="TableView_ShowGridMenu" />
</dxg:GridControl.View>
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.
    // ...
}

Inheritance

See Also