GridMenuEventArgs.MenuType Property

Gets the context menu’s type.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public GridMenuType? MenuType { get; }

VB.NET

Public ReadOnly Property MenuType As GridMenuType?

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.
TotalSummary	Corresponds to a menu invoked for the Summary Panel.
RowCell	Corresponds to a menu invoked for the Row Cell.
GroupPanel	Corresponds to a menu invoked for the group panel.
FixedTotalSummary	Corresponds to a menu invoked for the Fixed Summary Panel.
Band	Corresponds to a menu invoked for a band.
GroupFooterSummary	Corresponds to a menu invoked for the Group Footer‘s summary.
GroupRow	Corresponds to a menu invoked for the group row.
FixRowControl	Corresponds to a menu invoked for a fix row button.
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. 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 MenuType 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#

how-to-add-a-custom-button-to-a-column-header-e1838/CS/Window1.xaml.cs#L17

// If not - exit and leave the menu shown.
if (e.MenuType != GridMenuType.Column) return;

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

// Check whether this event was raised for a column's context menu.
if (e.MenuType != GridMenuType.Column) return;

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/CS/T686902/EditableColumnHeaderBehavior.cs#L36

private void View_ShowGridMenu(object sender, GridMenuEventArgs e) {
    if (e.MenuType == GridMenuType.Column) {
        GridColumnHeader columnHeader = e.TargetElement as GridColumnHeader;

VB.NET

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

' If not - exit and leave the menu shown.
If e.MenuType <> GridMenuType.Column Then
    Return

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

' Check whether this event was raised for a column's context menu.
If e.MenuType <> GridMenuType.Column Then
    Return

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/VB/T686902/EditableColumnHeaderBehavior.vb#L47

Private Sub View_ShowGridMenu(ByVal sender As Object, ByVal e As GridMenuEventArgs)
    If e.MenuType = GridMenuType.Column Then
        Dim columnHeader As GridColumnHeader = TryCast(e.TargetElement, GridColumnHeader)