PdfViewerControl.PopupMenuShowing Event

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

Namespace: DevExpress.Xpf.PdfViewer

Assembly: DevExpress.Xpf.PdfViewer.v24.1.dll

NuGet Package: DevExpress.Wpf.PdfViewer

Declaration

C#

public event PopupMenuShowingEventHandler PopupMenuShowing

VB.NET

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
Actions	Provides access to the collection of actions.
Cancel	Gets or sets whether the event should be canceled.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Example

This example shows how to remove items and add the “Save As…” item to the page content pop-up menu:

View Example

MainWindow.xaml

<Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:PopupMenuShowing"
        xmlns:dxpdf="http://schemas.devexpress.com/winfx/2008/xaml/pdf" x:Class="PopupMenuShowing.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <dxpdf:PdfViewerControl x:Name="viewer"
                                PopupMenuShowing="Viewer_PopupMenuShowing"/>
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Windows;
using DevExpress.Xpf.PdfViewer;
using DevExpress.Xpf.Bars;

namespace PopupMenuShowing {

    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();

            // Load a document.
            viewer.OpenDocument("..\\..\\Demo.pdf");
        }

        private void Viewer_PopupMenuShowing(DependencyObject d, PopupMenuShowingEventArgs e) {

            // Remove the Hand tool item from the page context popup menu.
            RemoveAction removeHandTool = new RemoveAction();
            removeHandTool.ElementName = DefaultPdfBarManagerItemNames.HandTool;
            e.Actions.Add(removeHandTool);

            // Remove the Select All item from the page context popup menu.
            RemoveAction removeSelectAll = new RemoveAction();
            removeSelectAll.ElementName = DefaultPdfBarManagerItemNames.SelectAll;
            e.Actions.Add(removeSelectAll);

            // Insert the "Save As..." item that invokes the Save As dialog.
            BarButtonItem barButtonItem = new BarButtonItem();
            barButtonItem.Content = "Save As...";
            barButtonItem.Command = viewer.SaveAsCommand;
            InsertAction insertBarButtonItem = new InsertAction();
            insertBarButtonItem.ContainerName = DefaultPdfBarManagerItemNames.ContextMenu;
            insertBarButtonItem.Element = barButtonItem;
            e.Actions.Add(insertBarButtonItem);
        }
    }
}

MainWindow.xaml.vb

Imports System.Windows
Imports DevExpress.Xpf.PdfViewer
Imports DevExpress.Xpf.Bars

Namespace PopupMenuShowing

    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()

            ' Load a document.
            viewer.OpenDocument("..\..\Demo.pdf")
        End Sub

        Private Sub Viewer_PopupMenuShowing(ByVal d As DependencyObject, ByVal e As PopupMenuShowingEventArgs)

            ' Remove the Hand tool item from the page context popup menu.
            Dim removeHandTool As New RemoveAction()
            removeHandTool.ElementName = DefaultPdfBarManagerItemNames.HandTool
            e.Actions.Add(removeHandTool)

            ' Remove the Select All item from the page context popup menu.
            Dim removeSelectAll As New RemoveAction()
            removeSelectAll.ElementName = DefaultPdfBarManagerItemNames.SelectAll
            e.Actions.Add(removeSelectAll)

            ' Insert the "Save As..." item that invokes the Save As dialog.
            Dim barButtonItem As New BarButtonItem()
            barButtonItem.Content = "Save As..."
            barButtonItem.Command = viewer.SaveAsCommand
            Dim insertBarButtonItem As New InsertAction()
            insertBarButtonItem.ContainerName = DefaultPdfBarManagerItemNames.ContextMenu
            insertBarButtonItem.Element = barButtonItem
            e.Actions.Add(insertBarButtonItem)
        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.

XAML

how-to-customize-the-popup-menu-t612865/CS/PopupMenuShowing/MainWindow.xaml#L12

<dxpdf:PdfViewerControl x:Name="viewer" PopupMenuShowing="Viewer_PopupMenuShowing"/>