PdfViewerControl.ExceptionMessage Event
Allows you to handle exceptions that may raise during various actions on the PDF Viewer.
Namespace: DevExpress.Xpf.PdfViewer
Assembly: DevExpress.Xpf.PdfViewer.v24.1.dll
NuGet Package: DevExpress.Wpf.PdfViewer
Declaration
Event Data
The ExceptionMessage event's data class is ExceptionMessageEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Exception | Gets the exception that caused the event. |
| 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. |
| Message | Gets or sets an error description displayed within an error message box. |
| MessageAction | Gets or sets an action to be performed when the PdfViewerControl.ExceptionMessage event occurs. |
| MessageImage | Gets or sets the icon displayed in the message box. |
| MessageOrigin | Gets the origin of an exception message. |
| 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. |
Remarks
Exceptions may be raised, for example, when you open/save a PDF document or import/export interactive form data. When an exception is caught, a message box is shown. You can handle the ExceptionMessage event to change this behavior. For instance, you can use the ExceptionMessageEventArgs.MessageAction property to suppress the notification or re-raise the exception.
Warning
The ExceptionMessage event is not raised in the following cases:
- When a document is loaded in code behind (i.e. with the PdfViewerControl.OpenDocument method call);
- When the PdfViewerControl.AsyncDocumentLoad is set to
false, and the exception occurs on the DocumentViewerControl.DocumentSource method call.