WebDocumentViewerExceptionHandler.GetExceptionMessage(Exception) Method

Enables you to handle all server-side errors independent of their types.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

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

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public override string GetExceptionMessage(
    Exception ex
)

VB.NET

Public Overrides Function GetExceptionMessage(
    ex As Exception
) As String

Parameters

Name	Type	Description
ex	Exception	An exception that occurs on the server side.

Returns

Type	Description
String	A string to show in a browser when an error occurs.

Remarks

The GetExceptionMessage method is called when any server-side error occurs.

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

C#

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

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

VB.NET

Imports System
Imports DevExpress.XtraReports.Web.WebDocumentViewer

Public Class CustomWebDocumentViewerExceptionHandler
    Inherits WebDocumentViewerExceptionHandler

    Public Overrides Function GetExceptionMessage(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 Web Forms)
• Handle Server-Side Errors in the Document Viewer (ASP.NET MVC)
• Handle Server-Side Errors in the Document Viewer (ASP.NET Core)

Implements

GetExceptionMessage(Exception)