FilterControl.PopupMenuShowing Event

Fires when a popup menu is about to be displayed for the FilterControl’s visual elements.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

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

VB.NET

<DXCategory("Events")>
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
Cancel	Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
CurrentNode	Gets the node where the menu is to be displayed.
FocusedElementType	Gets the type of the Filter Control’s element where the menu is to be displayed.
Menu	Gets the menu that will be invoked.
MenuType	Gets the type of the FilterControl’s menu to be invoked.
Point	Gets the position where the menu is to be invoked.
RestoreMenu	Gets or sets whether the current menu should be restored to its default state, after it has been displayed on-screen.

Remarks

When handling this event, you can use the event’s parameters to identify the clicked element, and the type of menu to be invoked. It’s possible to access and modify the menu, if required.

Using the event’s Cancel parameter, you can prevent the menu from being displayed.

Example

The following code shows how to remove the NOT AND and NOT OR operators from a FilterControl when the FilterControl is used in an Grid Control. These operators are removed via the FilterControl.PopupMenuShowing event. When a FilterControl is used within an Grid Control, you can access the FilterControl and subscribe to the FilterControl.PopupMenuShowing event by handling the ColumnView.FilterEditorCreated event.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-context-menus-for-a-filter-control-when-the-filtercontrol-is-used-within-an-e1492

Form1.cs

using System;
using System.Data;
using System.Windows.Forms;
using DevExpress.XtraEditors.Controls;
using DevExpress.XtraEditors.Filtering;

namespace Q101293 {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            DataTable tbl = new DataTable();
            tbl.Columns.Add("ID", typeof(int));
            tbl.Columns.Add("Name", typeof(string));
            tbl.Columns.Add("Check", typeof(bool));
            for(int i = 1; i < 10; i++)
                tbl.Rows.Add(i, string.Format("Item {0}", i), i % 2 == 0);
            gridControl1.DataSource = tbl;
            gridView1.ActiveFilterString = "[Check] = false";
        }

        private void gridView1_FilterEditorCreated(object sender, DevExpress.XtraGrid.Views.Base.FilterControlEventArgs e) {
            e.FilterControl.PopupMenuShowing += OnFilterControlPopupMenuShowing;
        }

        void OnFilterControlPopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
            if (e.MenuType == FilterControlMenuType.Group) {
                for (int i = e.Menu.Items.Count - 1; i >= 0; i--) {
                    if (e.Menu.Items[i].Caption == Localizer.Active.GetLocalizedString(StringId.FilterGroupNotAnd) ||
                        e.Menu.Items[i].Caption == Localizer.Active.GetLocalizedString(StringId.FilterGroupNotOr)) {
                        e.Menu.Items.RemoveAt(i);
                    }
                }
            }
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Data
Imports System.Windows.Forms
Imports DevExpress.XtraEditors.Controls
Imports DevExpress.XtraEditors.Filtering

Namespace Q101293
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            Dim tbl As New DataTable()
            tbl.Columns.Add("ID", GetType(Integer))
            tbl.Columns.Add("Name", GetType(String))
            tbl.Columns.Add("Check", GetType(Boolean))
            For i As Integer = 1 To 9
                tbl.Rows.Add(i, String.Format("Item {0}", i), i Mod 2 = 0)
            Next i
            gridControl1.DataSource = tbl
            gridView1.ActiveFilterString = "[Check] = false"
        End Sub

        Private Sub gridView1_FilterEditorCreated(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.FilterControlEventArgs) Handles gridView1.FilterEditorCreated
            AddHandler e.FilterControl.PopupMenuShowing, AddressOf OnFilterControlPopupMenuShowing
        End Sub

        Private Sub OnFilterControlPopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
            If e.MenuType = FilterControlMenuType.Group Then
                For i As Integer = e.Menu.Items.Count - 1 To 0 Step -1
                    If e.Menu.Items(i).Caption = Localizer.Active.GetLocalizedString(StringId.FilterGroupNotAnd) OrElse e.Menu.Items(i).Caption = Localizer.Active.GetLocalizedString(StringId.FilterGroupNotOr) Then
                        e.Menu.Items.RemoveAt(i)
                    End If
                Next i
            End If
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-customize-context-menus-for-a-filter-control-when-the-filtercontrol-is-used-within-an-e1492/CS/Q101293/Form1.cs#L25

private void gridView1_FilterEditorCreated(object sender, DevExpress.XtraGrid.Views.Base.FilterControlEventArgs e) {
    e.FilterControl.PopupMenuShowing += OnFilterControlPopupMenuShowing;
}

VB.NET

how-to-customize-context-menus-for-a-filter-control-when-the-filtercontrol-is-used-within-an-e1492/VB/Q101293/Form1.vb#L28

Private Sub gridView1_FilterEditorCreated(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.FilterControlEventArgs) Handles gridView1.FilterEditorCreated
    AddHandler e.FilterControl.PopupMenuShowing, AddressOf OnFilterControlPopupMenuShowing
End Sub