BarManager.SetPopupContextMenu(Control, PopupMenuBase) Method

Sets the popup menu for a control within a form.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

public void SetPopupContextMenu(
    Control control,
    PopupMenuBase menu
)

VB.NET

Public Sub SetPopupContextMenu(
    control As Control,
    menu As PopupMenuBase
)

Parameters

Name	Type	Description
control	Control	The control which the popup menu should be assigned to.
menu	PopupMenuBase	The popup menu to set.

Remarks

See the BarManager.GetPopupContextMenu topic for more information.

Example

This example creates a PopupMenu with three items and binds this menu to the form. You can right-click the form at runtime to invoke the menu.

View Example

Form1.cs

using DevExpress.XtraBars;
using DevExpress.XtraEditors;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

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

        private void Form1_Load(object sender, EventArgs e) {
            // Finish BarManager initialization (to allow its further customization on the form load)
            barManager1.ForceInitialize();

            DevExpress.XtraBars.PopupMenu menu = new DevExpress.XtraBars.PopupMenu();
            menu.Manager = barManager1;
            barManager1.Images = imageCollection1;
            BarButtonItem itemCopy = new BarButtonItem(barManager1, "Copy", 0);
            BarButtonItem itemPaste = new BarButtonItem(barManager1, "Paste", 1);
            BarButtonItem itemRefresh = new BarButtonItem(barManager1, "Refresh", 2);
            menu.AddItems(new BarItem[] { itemCopy, itemPaste, itemRefresh });
            // Create a separator before the Refresh item.
            itemRefresh.Links[0].BeginGroup = true;
            // Process item clicks.
            barManager1.ItemClick += BarManager1_ItemClick;
            // Associate the popup menu with the form.
            barManager1.SetPopupContextMenu(this, menu);
        }

        private void BarManager1_ItemClick(object sender, ItemClickEventArgs e) {
            XtraMessageBox.Show(e.Item.Caption + " item clicked");
        }
    }
}

Form1.vb

Imports DevExpress.XtraBars
Imports DevExpress.XtraEditors
Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks
Imports System.Windows.Forms

Namespace PopupMenu
    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 Me.Load
            ' Finish BarManager initialization (to allow its further customization on the form load)
            barManager1.ForceInitialize()


            Dim menu_Renamed As New DevExpress.XtraBars.PopupMenu()
            menu_Renamed.Manager = barManager1
            barManager1.Images = imageCollection1
            Dim itemCopy As New BarButtonItem(barManager1, "Copy", 0)
            Dim itemPaste As New BarButtonItem(barManager1, "Paste", 1)
            Dim itemRefresh As New BarButtonItem(barManager1, "Refresh", 2)
            menu_Renamed.AddItems(New BarItem() { itemCopy, itemPaste, itemRefresh })
            ' Create a separator before the Refresh item.
            itemRefresh.Links(0).BeginGroup = True
            ' Process item clicks.
            AddHandler barManager1.ItemClick, AddressOf BarManager1_ItemClick
            ' Associate the popup menu with the form.
            barManager1.SetPopupContextMenu(Me, menu_Renamed)
        End Sub

        Private Sub BarManager1_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
            XtraMessageBox.Show(e.Item.Caption & " item clicked")
        End Sub
    End Class
End Namespace