ExecuteDbCommand Event (DbCommandSetDataProvider)

In This Topic

Syntax

This event allows to edit the DbCommand before it is executed on the database.

Syntax

public event EventHandler<ExecuteDbCommandEventArgs> ExecuteDbCommand

public:
event EventHandler<ExecuteDbCommandEventArgs^>^ ExecuteDbCommand

'Declaration
 
Public Event ExecuteDbCommand As EventHandler(Of ExecuteDbCommandEventArgs)

Event Data

The event handler receives an argument of type ExecuteDbCommandEventArgs containing data related to this event. The following ExecuteDbCommandEventArgs properties provide information specific to this event.

Property	Description
Command	The IDbCommand instance which is to be executed on the database. You can e.g. edit the SQL statement or change the parameter values.
RecordLimit	A record limit that might be set (e.g. 1 when opening the Designer, 5 when drawing a crosstab preview etc.). If you modify the query, you could use this to optimize performance.
TableName	The table name for the command in the Designer.

Example

void MyCommandDataSetProvider_ExecuteDbCommand(object sender, ExecuteDbCommandEventArgs e)
{
  e.Command.CommandText = e.Command.CommandText.Replace("*", "[Address], [CustomerName], [City]");
}

VB.NET

Private Sub MyCommandDataSetProvider_ExecuteDbCommand(sender As Object, e As ExecuteDbCommandEventArgs)
	e.Command.CommandText = e.Command.CommandText.Replace("*", "[Address], [CustomerName], [City]")
End Sub

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 8, .NET 9

Reference

DbCommandSetDataProvider Class
DbCommandSetDataProvider Members

Send Feedback