GridView.PopupMenuShowing Event

Enables you to customize or prohibit built-in context menus.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.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 popup menu that is about to be displayed.
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

The Grid View provides built-in context menus for the following elements:

• Column headers (GridOptionsMenu.EnableColumnMenu)

• Group panel (GridOptionsMenu.EnableGroupPanelMenu)

• Summary footers (GridOptionsMenu.EnableFooterMenu)

• Auto-filter row (GridOptionsFilter.AllowAutoFilterConditionChange)

• Group/data rows. This menu is initially empty and is not displayed by default. To show this menu, add custom items to it using the PopupMenuShowing event.

To learn about the default contents of these menus, see Popup Menus.

By handling the PopupMenuShowing event, you can do the following:

• Prohibit display of these menus dynamically, according to your logic. Use the PopupMenuShowingEventArgs.Allow event parameter.
• Add custom items (regular buttons, check buttons and sub-menus) to these menus. Use the e.Menu.Items.Add method.
• Customize the existing menu items (change their captions, images, visibility, etc.). To learn how to access the existing items, see PopupMenuShowingEventArgs.Menu.

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 command that locks a clicked column’s position.

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(OnCanMoveItemClick));
    item.Tag = new MenuColumnInfo(column);
    return item;
}

// Menu item click handler.
void OnCanMoveItemClick(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;
}

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 OnCanMoveItemClick))
    item.Tag = New MenuColumnInfo(column)
    Return item
End Function

' Menu item click handler.
Private Sub OnCanMoveItemClick(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

Friend Class MenuColumnInfo
    Public Sub New(ByVal column As GridColumn)
        Me.Column = column
    End Sub
    Public Column As GridColumn
End Class

Example 2

This example illustrates how to disable or remove unwanted conditions from the Automatic Filtering Row. The sample below uses the XtraLocalizer<T>.GetLocalizedString method to remove common numeric filter conditions (less than, greater or equal than, etc.) for the “Postal Code” Grid column.

C#

using DevExpress.XtraGrid.Views.Grid;
using DevExpress.XtraEditors.Controls;

private void GridView1_PopupMenuShowing(object sender, DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs e) {
    GridView view = sender as GridView;
    if (e.MenuType == GridMenuType.AutoFilter && view.FocusedColumn == view.Columns["PostalCode"]) {
        //remove conditions
        e.Menu.Remove(ColumnAutoFilterCondition.Less);
        e.Menu.Remove(ColumnAutoFilterCondition.LessOrEqual);
        e.Menu.Remove(ColumnAutoFilterCondition.Greater);
        e.Menu.Remove(ColumnAutoFilterCondition.GreaterOrEqual);
        //disable conditions
        if (e.Menu.Find(ColumnAutoFilterCondition.Contains) != null)
            e.Menu.Find(ColumnAutoFilterCondition.Contains).Enabled = false;
        if (e.Menu.Find(ColumnAutoFilterCondition.DoesNotContain) != null)
            e.Menu.Find(ColumnAutoFilterCondition.DoesNotContain).Enabled = false;
    }
}

VB.NET

Imports DevExpress.XtraGrid.Views.Grid
Imports DevExpress.XtraEditors.Controls

Private Sub GridView1_PopupMenuShowing(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs)
    Dim view As GridView = TryCast(sender, GridView)
    If e.MenuType = GridMenuType.AutoFilter AndAlso view.FocusedColumn = view.Columns("PostalCode") Then
        'remove conditions
        e.Menu.Remove(ColumnAutoFilterCondition.Less)
        e.Menu.Remove(ColumnAutoFilterCondition.LessOrEqual)
        e.Menu.Remove(ColumnAutoFilterCondition.Greater)
        e.Menu.Remove(ColumnAutoFilterCondition.GreaterOrEqual)
        'disable conditions
        If e.Menu.Find(ColumnAutoFilterCondition.Contains) IsNot Nothing Then
            e.Menu.Find(ColumnAutoFilterCondition.Contains).Enabled = False
        End If
        If e.Menu.Find(ColumnAutoFilterCondition.DoesNotContain) IsNot Nothing Then
            e.Menu.Find(ColumnAutoFilterCondition.DoesNotContain).Enabled = False
        End If
    End If
End Sub