Context Menus

• Jun 13, 2022
• 3 minutes to read

The GridControl includes built-in context menus that you can customize according to your needs. These menus contain the most frequent user actions.

The table below lists grid elements that support context menus:

Element	Default Content	Property that Specifies the Context Menu
Group Panel		GridControl.GroupPanelMenu
Column Header		GridControl.ColumnMenu
Grouped Column Header		GridControl.ColumnMenu
Data cells, rows, and row indicator cells	-	GridControl.RowCellMenu
Empty space within the grid	-	GridControl.GridMenu

The following table lists context menu events. You can use them to customize the menu content and behavior:

Event	Description
GridControl.ContextMenuOpening	Occurs before a user opens a context menu.
GridControl.ContextMenuOpened	Occurs after a user opens a context menu.
GridControl.ContextMenuClosed	Occurs after a user closes a context menu.

Define a Custom Context Menu

The following code sample creates a custom context menu for grid rows:

1. Create a MenuFlyout control.
2. Fill it with MenuFlyoutItem objects.
3. Assign this control to the GridControl.RowCellMenu property.

XAML

<dxg:GridControl ...>
    <dxg:GridControl.RowCellMenu>
        <MenuFlyout>
            <MenuFlyoutItem Text="Delete" 
                            Command="{x:Bind ViewModel.DeleteRowCommand}" 
                            CommandParameter="{Binding Cell.CellData.Row}"/>
            <MenuFlyoutItem Text="Duplicate" 
                            Command="{x:Bind ViewModel.DuplicateRowCommand}" 
                            CommandParameter="{Binding Cell.CellData.Row}"/>
        </MenuFlyout>
    </dxg:GridControl.RowCellMenu>
</dxg:GridControl>

C#

public class MainViewModel : ViewModelBase {
    public MainViewModel() {
        // ...
        DeleteRowCommand = new DelegateCommand<Product>(DeleteRow);
        DuplicateRowCommand = new DelegateCommand<Product>(DuplicateRow);
    }
    // ...
    public DelegateCommand<Product> DeleteRowCommand { get; private set; }
    public DelegateCommand<Product> DuplicateRowCommand { get; private set; }

    public void DeleteRow(Product product) {
        Source.Remove(product);
    }
    public void DuplicateRow(Product product) {
        var index = Source.IndexOf(product);
        Source.Insert(index, product);
    }
}

VB.NET

Public Class MainViewModel
    Inherits ViewModelBase

    Public Sub New()
        ' ...
        DeleteRowCommand = New DelegateCommand(Of Product)(AddressOf DeleteRow)
        DuplicateRowCommand = New DelegateCommand(Of Product)(AddressOf DuplicateRow)
    End Sub
    ' ...
    Public Property DeleteRowCommand As DelegateCommand(Of Product)
    Public Property DuplicateRowCommand As DelegateCommand(Of Product)

    Public Sub DeleteRow(ByVal product As Product)
        Source.Remove(product)
    End Sub

    Public Sub DuplicateRow(ByVal product As Product)
        Dim index = Source.IndexOf(product)
        Source.Insert(index, product)
    End Sub
End Class

Add Items to the Context Menu

The code sample below uses the GridControl.ContextMenuOpening event to add the Show Search Panel and Hide Search Panel items to the group panel‘s context menu:

XAML

<dxg:GridControl ...
                 ShowGroupPanel="True" 
                 ContextMenuOpening="grid_ContextMenuOpening">
    <!-- ... -->
</dxg:GridControl>

C#

using DevExpress.WinUI.Grid;
using Microsoft.UI.Xaml.Controls;
// ...

void grid_ContextMenuOpening(object sender, DevExpress.WinUI.Core.Internal.ContextMenuOpeningEventArgs e) {
    var menuInfo = e.Info as GridGroupPanelContextMenuInfo;
    if (menuInfo != null) {
        var contextMenu = menuInfo.MenuContent;
        contextMenu.Items.Add(new MenuFlyoutSeparator());
        contextMenu.Items.Add(new MenuFlyoutItem() {Text = "Show Search Panel", Command = menuInfo.Commands.ShowSearchPanel});
        contextMenu.Items.Add(new MenuFlyoutItem() {Text = "Hide Search Panel", Command = menuInfo.Commands.HideSearchPanel});
    }
}

VB.NET

Imports DevExpress.WinUI.Grid
Imports Microsoft.UI.Xaml.Controls
' ...

Private Sub grid_ContextMenuOpening(ByVal sender As Object, ByVal e As DevExpress.WinUI.Core.Internal.ContextMenuOpeningEventArgs)
    Dim menuInfo = TryCast(e.Info, GridGroupPanelContextMenuInfo)

    If menuInfo IsNot Nothing Then
        Dim contextMenu = menuInfo.MenuContent
        contextMenu.Items.Add(New MenuFlyoutSeparator())
        contextMenu.Items.Add(New MenuFlyoutItem() With {
            .Text = "Show Search Panel",
            .Command = menuInfo.Commands.ShowSearchPanel
        })
        contextMenu.Items.Add(New MenuFlyoutItem() With {
            .Text = "Hide Search Panel",
            .Command = menuInfo.Commands.HideSearchPanel
        })
    End If
End Sub