GridView.PopupMenuShowing Event

Enables you to customize or prohibit grid context menus.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

[DXCategory("Behavior")]
public event PopupMenuShowingEventHandler PopupMenuShowing

VB.NET

<DXCategory("Behavior")>
Public Event PopupMenuShowing As PopupMenuShowingEventHandler

Event Data

The PopupMenuShowing event's data class is PopupMenuShowingEventArgs. The following properties provide information specific to this event:

Property	Description
Allow	Gets or sets whether to enable the Grid’s popup menu.
HitInfo	Gets an object that identifies a clicked element.
Menu	Gets or sets the Grid’s popup menu that will be shown.
MenuType	Gets the type of the Grid View’s menu to be invoked.
Point	Gets the position where the menu is to be invoked.

Remarks

Grid Views provide several context menus to end-users. These menu’s availability is controlled by the View’s GridView.OptionsMenu property. The property provides access to an object that contains a set of Boolean properties. Each property specifies whether particular types of menus are available.

If the GridView.OptionsMenu property allows you to invoke a menu, the PopupMenuShowing event fires each time a user attempts to invoke a context menu. This event’s parameters enable you to identify which menu is about to be displayed, customize the menu or prohibit it from being invoked.

Example

The following sample code handles the GridView.PopupMenuShowing event to customize the column header context menu before it is displayed. The code clears default menu items and adds a new one which determines whether the column header can be moved within the column header panel.

C#

using DevExpress.XtraGrid.Menu;
using DevExpress.Utils.Menu;
using DevExpress.XtraGrid.Columns; 
using DevExpress.XtraGrid.Views.Grid;
// ...
private void bandedGridView1_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    if(e.MenuType == GridMenuType.Column) {
        GridViewColumnMenu menu = e.Menu as GridViewColumnMenu;
        menu.Items.Clear();
        if(menu.Column != null) {
            menu.Items.Add(CreateCheckItem("Lock this column", menu.Column, null));
        }
    }
}

// Creates a menu item.
DXMenuCheckItem CreateCheckItem(string caption, GridColumn column, Image image) {
    DXMenuCheckItem item = new DXMenuCheckItem(caption, 
      !column.OptionsColumn.AllowMove, image, new EventHandler(OnCanMovedItemClick));
    item.Tag = new MenuColumnInfo(column);
    return item;
}

// Menu item click handler.
void OnCanMovedItemClick(object sender, EventArgs e) {
    DXMenuCheckItem item = sender as DXMenuCheckItem;
    MenuColumnInfo info = item.Tag as MenuColumnInfo;
    if(info == null) return;
    info.Column.OptionsColumn.AllowMove = !item.Checked;
}

// The class that stores menu specific information.
class MenuColumnInfo {
    public MenuColumnInfo(GridColumn column) {
        this.Column = column;               
    }
    public GridColumn Column;
}

VB.NET

Imports DevExpress.XtraGrid.Menu
Imports DevExpress.Utils.Menu
Imports DevExpress.XtraGrid.Columns
Imports DevExpress.XtraGrid.Views.Grid
' ...
Private Sub bandedGridView1_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    If e.MenuType = GridMenuType.Column Then
        Dim menu As GridViewColumnMenu = TryCast(e.Menu, GridViewColumnMenu)
        menu.Items.Clear()
        If menu.Column IsNot Nothing Then
            menu.Items.Add(CreateCheckItem("Lock this column", menu.Column, Nothing))
        End If
    End If
End Sub

' Creates a menu item.
Private Function CreateCheckItem(ByVal caption As String, ByVal column As GridColumn, ByVal image As Image) As DXMenuCheckItem
    Dim item As New DXMenuCheckItem(caption, (Not column.OptionsColumn.AllowMove), image, New EventHandler(AddressOf OnCanMovedItemClick))
    item.Tag = New MenuColumnInfo(column)
    Return item
End Function

' Menu item click handler.
Private Sub OnCanMovedItemClick(ByVal sender As Object, ByVal e As EventArgs)
    Dim item As DXMenuCheckItem = TryCast(sender, DXMenuCheckItem)
    Dim info As MenuColumnInfo = TryCast(item.Tag, MenuColumnInfo)
    If info Is Nothing Then
        Return
    End If
    info.Column.OptionsColumn.AllowMove = Not item.Checked
End Sub

' The class that stores menu specific information.
Friend Class MenuColumnInfo
    Public Sub New(ByVal column As GridColumn)
        Me.Column = column
    End Sub
    Public Column As GridColumn
End Classc information.
Class MenuColumnInfo
    Public Sub New(ByVal column As GridColumn)
        Me.Column = column
    End Sub
    Public Column As GridColumn
End Class

Related GitHub Examples

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

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-allow-an-end-user-to-show-hide-a-grid-view-filter-panel-via-a-grid-view-context-menu-e3685/CS/GridViewFilterOptions.cs#L71

if (handlePopuMenuShowing)
    ViewSender.PopupMenuShowing += new PopupMenuShowingEventHandler(ViewSender_PopupMenuShowing);
else

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/CS/WindowsApplication3/SortDialogProvider.cs#L26

{
    view.PopupMenuShowing += OnPopupMenuShowing;
    view.CustomDrawColumnHeader += OnCustomDrawColumnHeader;

how-to-provide-the-capability-to-create-fixed-rows-in-the-gridview-e3045/CS/SplitDescendantWithExtension/FixedRowsExtension.cs#L66

gridViewPanel1.CustomRowFilter += gridViewPanel1_CustomRowFilter;
gridViewPanel1.PopupMenuShowing += gridViewPanel1_PopupMenuShowing;
gridViewPanel2 = gridSplitContainer1.SplitChildGrid.MainView as GridView;

how-to-add-a-custom-summary-item-to-the-grids-footer-menu-e496/CS/Form1.cs#L44

    gridView1.OptionsView.ShowFooter = true;
    gridView1.PopupMenuShowing += new DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventHandler(gridView1_PopupMenuShowing);
}

how-to-edit-values-within-a-group-via-an-editable-group-row-e3065/CS/EditableGroupRow/GroupRowEdit.cs#L24

    View = view;
    View.PopupMenuShowing +=new PopupMenuShowingEventHandler(View_PopupMenuShowing);
}

VB.NET

how-to-allow-an-end-user-to-show-hide-a-grid-view-filter-panel-via-a-grid-view-context-menu-e3685/VB/GridViewFilterOptions.vb#L62

If handlePopuMenuShowing Then
    AddHandler ViewSender.PopupMenuShowing, AddressOf ViewSender_PopupMenuShowing
Else

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/VB/WindowsApplication3/SortDialogProvider.vb#L23

Public Sub EnableSortDialog()
    AddHandler view.PopupMenuShowing, AddressOf OnPopupMenuShowing
    AddHandler view.CustomDrawColumnHeader, AddressOf OnCustomDrawColumnHeader

how-to-provide-the-capability-to-create-fixed-rows-in-the-gridview-e3045/VB/SplitDescendantWithExtension/FixedRowsExtension.vb#L65

AddHandler gridViewPanel1.CustomRowFilter, AddressOf gridViewPanel1_CustomRowFilter
AddHandler gridViewPanel1.PopupMenuShowing, AddressOf gridViewPanel1_PopupMenuShowing
gridViewPanel2 = TryCast(gridSplitContainer1.SplitChildGrid.MainView, GridView)

how-to-add-a-custom-summary-item-to-the-grids-footer-menu-e496/VB/Form1.vb#L43

    gridView1.OptionsView.ShowFooter = True
    AddHandler gridView1.PopupMenuShowing, AddressOf gridView1_PopupMenuShowing
End Sub

how-to-edit-values-within-a-group-via-an-editable-group-row-e3065/VB/EditableGroupRow/GroupRowEdit.vb#L22

    Me.View = view
    AddHandler Me.View.PopupMenuShowing, AddressOf View_PopupMenuShowing
End Sub