Skip to main content

PdfViewerControl.UriOpening Event

Occurs after clicking a hyperlink addressing an external URI (universal resource identifier).

Namespace: DevExpress.Xpf.PdfViewer

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

NuGet Package: DevExpress.Wpf.PdfViewer

Declaration

public event UriOpeningEventHandler UriOpening

Event Data

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

Property Description
Cancel Gets or sets a value that specifies how to manage the URI opening behavior without the Security Warning message box; if true, the URI is not opened.
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.
OriginalUriString Gets the original URI string from which the Uri object is created.
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.
Uri Gets the opened document’s URI (Uniform Resource Identifier).

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.

Remarks

The following image illustrates a security warning displayed in a PDF Viewer when clicking a hyperlink addressing an external URI.

pdf-viewer-hyperlink-external-uri-security-warning

Set the e.Handled property to true if you want to hide the message box. You can prevent URI opening without using the message box (e.Handled should be set to true) by setting the e.Cancel property to true.

See Also