ExceptionHandler.GetFaultExceptionMessage(FaultException) Method

Enables you to handle FaultException that occurs on the server side.

Namespace: DevExpress.XtraReports.Web.ClientControls

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

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public virtual string GetFaultExceptionMessage(
    FaultException ex
)

VB.NET

Public Overridable Function GetFaultExceptionMessage(
    ex As FaultException
) As String

Parameters

Name	Type	Description
ex	FaultException	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 GetFaultExceptionMessage method is called whenever FaultException occurs (for instance, when you pass an invalid URL to a report storage).

The following classes are inherited from the base ExceptionHandler class and provide this method:

• ReportDesignerExceptionHandler
• WebDocumentViewerExceptionHandler
• QueryBuilderExceptionHandler

The code snippet below demonstrates how to create a descendant from the ReportDesignerExceptionHandler class and override the GetExceptionMessage method to return a custom message.

C#

using System;
using System.ServiceModel;
using DevExpress.XtraReports.Web.ReportDesigner.Services;

public class CustomReportDesignerExceptionHandler : ReportDesignerExceptionHandler {
    public override string GetFaultExceptionMessage(FaultException ex) {
        return "FaultException occured.";
    }
}

VB.NET

Imports System
Imports System.ServiceModel
Imports DevExpress.XtraReports.Web.ReportDesigner.Services

Public Class CustomReportDesignerExceptionHandler
    Inherits ReportDesignerExceptionHandler

    Public Overrides Function GetFaultExceptionMessage(ByVal ex As FaultException) As String
        Return "FaultException occured."
    End Function
End Class

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

C#

void Application_Start(object sender, EventArgs e) {
    // ...
    DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.
        Register<IReportDesignerExceptionHandler, CustomReportDesignerExceptionHandler>();
}

VB.NET

Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...
    DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.
        Register(Of IReportDesignerExceptionHandler, CustomReportDesignerExceptionHandler)()
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)