XRDesignMdiController.ValidateCustomSql Event

Occurs when a custom SQL query is validated.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v25.1.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public event EventHandler<ValidateSqlEventArgs> ValidateCustomSql

VB.NET

Public Event ValidateCustomSql As EventHandler(Of ValidateSqlEventArgs)

Event Data

The ValidateCustomSql event's data class is ValidateSqlEventArgs. The following properties provide information specific to this event:

Property	Description
ConnectionParameters	Provides access to settings used to establish the current data connection.
Message	Specifies the error message to display if query validation fails.
Sql	Contains the SQL query to validate.
Valid	Specifies whether the query is valid.

Remarks

This event is raised when a user enters a custom SQL query in the Report Designer’s Query Builder UI. Use this event when you want to control/validate custom SQL queries entered by the user. Define your custom query validation logic in the event handler as follows:

1. Select the Report Designer’s XRDesignMdiController in the component tray:

   

2. Handle the XRDesignMdiController.ValidateCustomSql event:

   

3. In the event handler, define your custom query validation logic:

   C#

   using DevExpress.XtraReports.UserDesigner;
   // ...
   private void reportDesigner1_ValidateCustomSql(object sender, ValidateSqlEventArgs e) {
       string sql = e.Sql;
       bool validationResult;
       // Insert your custom validation logic here.
       e.Valid = validationResult;
   }
   

   VB.NET

   Imports DevExpress.XtraReports.UserDesigner
   ' ...
   Private Sub reportDesigner1_ValidateCustomSql(ByVal sender As Object, ByVal e As ValidateSqlEventArgs)
       Dim sql As String = e.Sql
       Dim validationResult As Boolean
       ' Insert your custom validation logic here.
       e.Valid = validationResult
   End Sub
   

To validate custom SQL for all queries created in an End-User Report Designer for WinForms, handle the SqlDataSource.ValidateCustomSqlQueryGlobal event.