GridMenuEventArgs.MenuType Property

Gets the context menu’s type.

Namespace: DevExpress.Xpf.Grid

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

Declaration

public GridMenuType? MenuType { get; }

Property Value

Type Description
Nullable<GridMenuType>

A GridMenuType enumeration value that identifies the context menu.

Available values:

Show 12 items
Name Description
Column

Corresponds to a menu invoked for a column header.

GridMenuType_Column

TotalSummary

Corresponds to a menu invoked for the Summary Panel.

GridMenuType_Summary

RowCell

Corresponds to a menu invoked for the Row Cell.

GroupPanel

Corresponds to a menu invoked for the group panel.

GridMenuType_GroupPanel

FixedTotalSummary

Corresponds to a menu invoked for the Fixed Summary Panel.

fixedsummarycontextmenu

Band

Corresponds to a menu invoked for a band.

band_menu

GroupFooterSummary

Corresponds to a menu invoked for the Group Footer‘s summary.

GridMenuType_Summary

GroupRow

Corresponds to a menu invoked for the group row.

FixRowControl

Corresponds to a menu invoked for a fix row button.

WPF_Grid_FixedRows_ContextMenu.png

CompactPanelSortElement

Corresponds to a menu invoked for sort items in compact panel.

CompactPanelFilter

Corresponds to a menu invoked for a compact panel filter.

CompactPanelMergeMenu

Corresponds to a merged menu invoked for a filter and sort items in compact panel.

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

<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.
    // ...
}
See Also