WebDocumentViewerExceptionHandler Class

Enables you to handle server-side errors in the Web Document Viewer.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

Assembly: DevExpress.XtraReports.v18.2.Web.dll

Declaration

C#

public class WebDocumentViewerExceptionHandler :
    ExceptionHandler,
    IWebDocumentViewerExceptionHandler,
    IExceptionHandler

VB.NET

Public Class WebDocumentViewerExceptionHandler
    Inherits ExceptionHandler
    Implements IWebDocumentViewerExceptionHandler,
               IExceptionHandler

Remarks

The WebDocumentViewerExceptionHandler class provides the following methods:

• GetUnknownExceptionMessage to handle exceptions of non-standard types, for which the Document Viewer shows the standard ‘Internal Server Error’ message;
• GetFaultExceptionMessage to handle FaultException;
• DocumentCreationException to handle errors related to the document creation process;
• GetExceptionMessage to handle all possible errors independently from their types.

The code snippet below demonstrates how to create a descendant from this class and override the GetUnknownExceptionMessage method to return an actual exception message.

C#

using System;
using DevExpress.XtraReports.Web.WebDocumentViewer;

public class CustomWebDocumentViewerExceptionHandler : WebDocumentViewerExceptionHandler {
    public override string GetUnknownExceptionMessage(Exception ex) {
        return ex.Message;
    }
}

VB.NET

Imports System
Imports DevExpress.XtraReports.Web.WebDocumentViewer

Public Class CustomWebDocumentViewerExceptionHandler
    Inherits WebDocumentViewerExceptionHandler

    Public Overrides Function GetUnknownExceptionMessage(ByVal ex As Exception) As String
        Return ex.Message
    End Function
End Class

To register the implemented exception handler, use the static DefaultWebDocumentViewerContainer.Register method at the application’s startup as shown below:

C#

void Application_Start(object sender, EventArgs e) {
    // ...
    DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.
      Register<IWebDocumentViewerExceptionHandler, CustomWebDocumentViewerExceptionHandler>();
}

VB.NET

Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...
    DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.
      Register(Of IWebDocumentViewerExceptionHandler, CustomWebDocumentViewerExceptionHandler)()
End Sub

See the following topics for more information:

• Handle Server-Side Errors in the Document Viewer (ASP.NET WebForms)
• Handle Server-Side Errors in the Document Viewer (ASP.NET MVC)
• Handle Server-Side Errors in the Document Viewer (ASP.NET Core)

Implements

IWebDocumentViewerExceptionHandler

IExceptionHandler

Inheritance

Object

ExceptionHandler

WebDocumentViewerExceptionHandler