QueryBuilderExceptionHandler Class

Enables you to handle server-side errors in the Web Query Builder.

Namespace: DevExpress.XtraReports.Web.QueryBuilder.Services

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

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public class QueryBuilderExceptionHandler :
    ExceptionHandler,
    IQueryBuilderExceptionHandler,
    IExceptionHandler

VB.NET

Public Class QueryBuilderExceptionHandler
    Inherits ExceptionHandler
    Implements IQueryBuilderExceptionHandler,
               IExceptionHandler

Remarks

The QueryBuilderExceptionHandler class has the following methods inherited from the base class:

• GetUnknownExceptionMessage to handle exceptions of non-standard types, for which the Query Builder shows the standard ‘Internal Server Error’ message;
• GetFaultExceptionMessage to handle FaultException;
• GetExceptionMessage to handle all possible errors independent of 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.QueryBuilder.Services;

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

VB.NET

Imports System
Imports DevExpress.XtraReports.Web.QueryBuilder.Services

Public Class CustomQueryBuilderExceptionHandler
    Inherits QueryBuilderExceptionHandler

    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 DefaultQueryBuilderContainer.Register method at the application’s startup as shown below:

C#

void Application_Start(object sender, EventArgs e) {
    // ...
    DevExpress.XtraReports.Web.QueryBuilder.DefaultQueryBuilderContainer.
      Register<IQueryBuilderExceptionHandler, CustomQueryBuilderExceptionHandler>();
}

VB.NET

Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...
    DevExpress.XtraReports.Web.QueryBuilder.DefaultQueryBuilderContainer.
      Register(Of IQueryBuilderExceptionHandler, CustomQueryBuilderExceptionHandler)()
End Sub

Implements

IQueryBuilderExceptionHandler

IExceptionHandler

Inheritance

Object

ExceptionHandler

QueryBuilderExceptionHandler