PdfViewer.PopupMenuShowing Event

Occurs after the popup menu of a PDF Viewer has been invoked.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v18.1.dll

Declaration

C#

public event PdfPopupMenuShowingEventHandler PopupMenuShowing

VB.NET

Public Event PopupMenuShowing As PdfPopupMenuShowingEventHandler

Event Data

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

Property	Description
ItemLinks	Gets the collection of popup menu links displayed when the menu is being invoked.
Menu	Obsolete. Provides access to a popup menu that is being invoked.
PopupMenuKind	Gets the type of a particular popup menu shown for the PDF Viewer.

Example

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781

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

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.

VB.NET

how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781/VB/CustomPopupMenu/Form1.vb#L14

Private Sub pdfViewer1_PopupMenuShowing(ByVal sender As Object, ByVal e As PdfPopupMenuShowingEventArgs) Handles pdfViewer1.PopupMenuShowing
    ' Create a bar button item.

how-to-remove-items-from-the-popup-menu-t602115/VB/RemoveItemsFromPopupMenu/Form1.vb#L14

Private Sub pdfViewer1_PopupMenuShowing(ByVal sender As Object, ByVal e As PdfPopupMenuShowingEventArgs) Handles pdfViewer1.PopupMenuShowing
    ' Hide the popup menu for the bookmark tree.