How to: Add a Custom Bar Button Item to the Popup Menu

• Nov 13, 2018
• 2 minutes to read

This example demonstrates how to add a custom bar button item to the popup menu.

To add a new item to a popup menu shown for the navigation pane of a PDF Viewer, handle the PdfViewer.PopupMenuShowing event and then use the PdfPopupMenuShowingEventArgs.ItemLinks property.

View Example

Form1.cs

using System.Windows.Forms;
using DevExpress.XtraPdfViewer;
using DevExpress.XtraBars;

namespace CustomPopupMenu {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
            pdfViewer1.LoadDocument("..\\..\\Demo.pdf");
        }

        void pdfViewer1_PopupMenuShowing(object sender, PdfPopupMenuShowingEventArgs e) {
            // Create a bar button item.
            BarButtonItem browseBarButton = new BarButtonItem();
            browseBarButton.Caption = "Custom Item";

            // Insert the bar buttom item into the PDF Viewer popup menu and start a new group.
            e.ItemLinks.Add(browseBarButton, true);

            // Handle the bar button click event.
            browseBarButton.ItemClick += browseBarButton_ItemClick;
        }

        void browseBarButton_ItemClick(object sender, ItemClickEventArgs e) {
            MessageBox.Show("ItemClick event fires");
        }
    }
}

Form1.vb

Imports System.Windows.Forms
Imports DevExpress.XtraPdfViewer
Imports DevExpress.XtraBars

Namespace CustomPopupMenu
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            pdfViewer1.LoadDocument("..\..\Demo.pdf")
        End Sub

        Private Sub pdfViewer1_PopupMenuShowing(ByVal sender As Object, ByVal e As PdfPopupMenuShowingEventArgs) Handles pdfViewer1.PopupMenuShowing
            ' Create a bar button item.
            Dim browseBarButton As New BarButtonItem()
            browseBarButton.Caption = "Custom Item"

            ' Insert the bar buttom item into the PDF Viewer popup menu and start a new group.
            e.ItemLinks.Add(browseBarButton, True)

            ' Handle the bar button click event.
            AddHandler browseBarButton.ItemClick, AddressOf browseBarButton_ItemClick
        End Sub

        Private Sub browseBarButton_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
            MessageBox.Show("ItemClick event fires")
        End Sub
    End Class
End Namespace