PdfPopupMenuShowingEventArgs.PopupMenuKind Property

Gets the type of a particular popup menu shown for the PDF Viewer.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v18.2.dll

Declaration

C#

public PdfPopupMenuKind PopupMenuKind { get; }

VB.NET

Public ReadOnly Property PopupMenuKind As PdfPopupMenuKind

Property Value

Type	Description
PdfPopupMenuKind	A PdfPopupMenuKind enumeration value which represents the kind of a popup menu shown for the PDF Viewer.

Available values:

Name	Description
PageContent	Specifies a popup menu that can be invoked by right clicking the page content of the PDF Viewer.
BookmarkTree	Specifies a popup menu that can be invoked by right clicking the bookmark item in the bookmarks hierarchical tree on the Navigation pane of the PDF Viewer.
BookmarkOptions	Specifies a popup menu that can be invoked by clicking the Options drop-down button in the Bookmarks panel of the PDF Viewer.
Thumbnail	Specifies a popup menu that can be invoked by right clicking the page thumbnail on the Navigation pane of the PDF Viewer.
ThumbnailOptions	Specifies a popup menu that can be invoked by clicking the Options drop-down button in the Page Thumbnails panel of the PDF Viewer.

Example

The PDF Viewer has several types of popup menus that can be invoked by an end-user for bookmark options, bookmark tree, page content, thumbnail and thumbnail options.

This example shows how to hide the popup menu for the bookmark tree and remove specific items from the page content popup menu.

To customize items of the PDF Viewer’s popup menu, handle the PdfViewer.PopupMenuShowing event. This event fires every time an end-user opens a popup menu in the PDF Viewer.

Each popup menu type has a unique set of bar items that are located in the bar item link collection. To access this collection, check the popup menu type using the PdfPopupMenuShowingEventArgs.PopupMenuKind property and use the PdfPopupMenuShowingEventArgs.ItemLinks property.

To hide a popup menu, clear all items from the bar item link collection.

To remove an item from a popup menu, find the item by the caption in the bar item link collection and then remove it.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-remove-items-from-the-popup-menu-t602115

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) {
            // Hide the popup menu for the bookmark tree.
            if (e.PopupMenuKind == PdfPopupMenuKind.BookmarkTree) {
                e.ItemLinks.Clear();
            }

            // Remove Rotate Clockwise and Rotate Counterclockwise items from the Page Content popup menu.
            if (e.PopupMenuKind == PdfPopupMenuKind.PageContent) {
                for (int i = e.ItemLinks.Count - 1; i >= 0; i--) {
                    BarItemLink link = e.ItemLinks[i];
                    if (link.Caption.Contains("Rotate"))
                        e.ItemLinks.Remove(link);
                }
            }
        }
    }
}

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
            ' Hide the popup menu for the bookmark tree.
            If e.PopupMenuKind = PdfPopupMenuKind.BookmarkTree Then
                e.ItemLinks.Clear()
            End If

            ' Remove Rotate Clockwise and Rotate Counterclockwise items from the Page Content popup menu.
            If e.PopupMenuKind = PdfPopupMenuKind.PageContent Then
                For i As Integer = e.ItemLinks.Count - 1 To 0 Step -1
                    Dim link As BarItemLink = e.ItemLinks(i)
                    If link.Caption.Contains("Rotate") Then
                        e.ItemLinks.Remove(link)
                    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 PopupMenuKind property.

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-remove-items-from-the-popup-menu-t602115/CS/RemoveItemsFromPopupMenu/Form1.cs#L14

// Hide the popup menu for the bookmark tree.
if (e.PopupMenuKind == PdfPopupMenuKind.BookmarkTree) {
    e.ItemLinks.Clear();

VB.NET

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

' Hide the popup menu for the bookmark tree.
If e.PopupMenuKind = PdfPopupMenuKind.BookmarkTree Then
    e.ItemLinks.Clear()