SqlDataSourceCommandEventArgs Class
Provides data for the Updating, Deleting and Inserting events of the SqlDataSource control.
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.SqlDataSourceCommandEventArgs
System.Web.UI.WebControls.SqlDataSourceSelectingEventArgs
Assembly: System.Web (in System.Web.dll)
The SqlDataSourceCommandEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | SqlDataSourceCommandEventArgs | Initializes a new instance of the SqlDataSourceCommandEventArgs class, using the specified database command object. |
| Name | Description | |
|---|---|---|
| Cancel | Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.) |
| Command | Gets the pending database command. |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
By adding an event handler delegate to handle the Updating, Inserting, or Deleting events, you can perform any additional preprocessing required or cancel the database command entirely.
Because the SqlDataSourceCommandEventArgs class is derived from the CancelEventArgs class, you can cancel a pending SqlDataSource database command by setting the Cancel property to true. You can examine and manipulate the CommandText, Parameters collection, and other command properties prior to running the command by accessing the DbCommand object exposed by the Command property.
The SqlDataSourceCommandEventArgs class is used in the OnUpdating, OnInserting, and OnDeleting methods to provide access to a SqlDataSource database command before it is run. The SqlDataSource control exposes many events that you can handle to work with the underlying data objects during the course of a data operation. The following table lists the events and associated EventArgs and event handler classes, to better guide you to the various events that correspond to the lifecycle of a data operation using the SqlDataSource control.
Event | EventArgs | EventHandler |
|---|---|---|
Selecting occurs before the data is retrieved. | ||
Inserting, Updating, Deleting occur before an insert, update, or delete operation is performed. | SqlDataSourceCommandEventArgs | |
Selected, Inserted, Updated, Deleted occur after the data retrieval, insert, update, or delete operations completes. |
The following code example demonstrates how to display data retrieved from a Microsoft SQL Server database in a DropDownList control, and update the record using a TextBox control. The example shows how you can use a DbTransaction object to add transaction context when using the SqlDataSource control to update data.
<%@Page Language="C#" %> <%@Import Namespace="System.Data" %> <%@Import Namespace="System.Data.Common" %> <%@Import Namespace="System.Data.SqlClient" %> <%@Import Namespace="System.Diagnostics" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> private void On_Click(Object source, EventArgs e) { SqlDataSource1.Update(); } private void OnSqlUpdating(Object source, SqlDataSourceCommandEventArgs e) { DbCommand command = e.Command; DbConnection cx = command.Connection; cx.Open(); DbTransaction tx = cx.BeginTransaction(); command.Transaction = tx; } private void OnSqlUpdated(Object source, SqlDataSourceStatusEventArgs e) { DbCommand command = e.Command; DbTransaction tx = command.Transaction; // In this code example the OtherProcessSucceeded variable represents // the outcome of some other process that occurs whenever the data is // updated, and must succeed for the data change to be committed. For // simplicity, we set this value to true. bool OtherProcessSucceeded = true; if (OtherProcessSucceeded) { tx.Commit(); Label2.Text="The record was updated successfully!"; } else { tx.Rollback(); Label2.Text="The record was not updated."; } } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <asp:SqlDataSource id="SqlDataSource1" runat="server" ConnectionString="<%$ ConnectionStrings:MyNorthwind%>" SelectCommand="SELECT EmployeeID, LastName, Address FROM Employees" UpdateCommand="UPDATE Employees SET Address=@Address WHERE EmployeeID=@EmployeeID" OnUpdating="OnSqlUpdating" OnUpdated ="OnSqlUpdated"> <UpdateParameters> <asp:ControlParameter Name="Address" ControlId="TextBox1" PropertyName="Text"/> <asp:ControlParameter Name="EmployeeID" ControlId="DropDownList1" PropertyName="SelectedValue"/> </UpdateParameters> </asp:SqlDataSource> <asp:DropDownList id="DropDownList1" runat="server" DataTextField="LastName" DataValueField="EmployeeID" DataSourceID="SqlDataSource1"> </asp:DropDownList> <br /> <asp:Label id="Label1" runat="server" Text="Enter a new address for the selected user." AssociatedControlID="TextBox1" /> <asp:TextBox id="TextBox1" runat="server" /> <asp:Button id="Submit" runat="server" Text="Submit" OnClick="On_Click" /> <br /><asp:Label id="Label2" runat="server" Text="" /> </form> </body> </html>
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.