Back to Devexpress

IQueryBuilderExceptionHandler Interface

xtrareports-devexpress-dot-xtrareports-dot-web-dot-querybuilder-dot-services-401dd487.md

latest3.0 KB
Original Source

IQueryBuilderExceptionHandler Interface

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

Namespace : DevExpress.XtraReports.Web.QueryBuilder.Services

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

NuGet Package : DevExpress.Web.Reporting.Common

Declaration

csharp
public interface IQueryBuilderExceptionHandler :
    IExceptionHandler
vb
Public Interface IQueryBuilderExceptionHandler
    Inherits IExceptionHandler

Remarks

This interface is inherited from the base IExceptionHandler interface and exposes the GetExceptionMessage method that is called when any server-side error occurs.

The following code snippet demonstrates how to implement this method and return an actual exception message:

csharp
using System;
using DevExpress.XtraReports.Web.QueryBuilder.Services;

public class CustomExceptionHandler : IQueryBuilderExceptionHandler {
    public string GetExceptionMessage(Exception ex) {
        return ex.Message;
    }
}
vb
Imports System
Imports DevExpress.XtraReports.Web.QueryBuilder.Services

Public Class CustomExceptionHandler
    Inherits IQueryBuilderExceptionHandler

    Public Function GetExceptionMessage(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:

csharp
void Application_Start(object sender, EventArgs e) {
    // ...
    DevExpress.XtraReports.Web.QueryBuilder.DefaultQueryBuilderContainer.
        Register<IQueryBuilderExceptionHandler, CustomExceptionHandler>();
}
vb
Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...
    DevExpress.XtraReports.Web.QueryBuilder.DefaultQueryBuilderContainer.
        Register(Of IQueryBuilderExceptionHandler, CustomExceptionHandler)()
End Sub

See Also

IQueryBuilderExceptionHandler Members

DevExpress.XtraReports.Web.QueryBuilder.Services Namespace