SqlDataSourceCommandEventArgs, classe (System.Web.UI.WebControls)

Réduire tout

Filtre de language

Affichage du contenu : côte à côte

.NET Framework Class Library

SqlDataSourceCommandEventArgs Class

Provides data for the Updating, Deleting and Inserting events of the SqlDataSource control.

Inheritance Hierarchy

System..::.Object
  System..::.EventArgs
    System.ComponentModel..::.CancelEventArgs
      System.Web.UI.WebControls..::.SqlDataSourceCommandEventArgs
        System.Web.UI.WebControls..::.SqlDataSourceSelectingEventArgs

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic

Public Class SqlDataSourceCommandEventArgs _
    Inherits CancelEventArgs

public class SqlDataSourceCommandEventArgs : CancelEventArgs

Visual C++

public ref class SqlDataSourceCommandEventArgs : public CancelEventArgs

type SqlDataSourceCommandEventArgs =  
    class
        inherit CancelEventArgs
    end

The SqlDataSourceCommandEventArgs type exposes the following members.

Constructors

	Name	Description
	SqlDataSourceCommandEventArgs	Initializes a new instance of the SqlDataSourceCommandEventArgs class, using the specified database command object.

Top

Properties

	Name	Description
	Cancel	Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
	Command	Gets the pending database command.

Top

Methods

	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.)

Top

Remarks

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.	SqlDataSourceSelectingEventArgs	SqlDataSourceSelectingEventHandler
Inserting, Updating, Deleting occur before an insert, update, or delete operation is performed.	SqlDataSourceCommandEventArgs	SqlDataSourceCommandEventHandler
Selected, Inserted, Updated, Deleted occur after the data retrieval, insert, update, or delete operations completes.	SqlDataSourceStatusEventArgs	SqlDataSourceStatusEventHandler

Examples

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.

Visual Basic

<%@Page  Language="VB" %>
<%@Import Namespace="System.Data" %>
<%@Import Namespace="System.Data.Common" %>
<%@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">

 Sub On_Click(ByVal source As Object, ByVal e As EventArgs)
        SqlDataSource1.Update()
 End Sub 'On_Click

 Sub On_Sql_Updating(ByVal source As Object, ByVal e As SqlDataSourceCommandEventArgs)
     Dim command as DbCommand
     Dim connection as DbConnection
     Dim transaction as DbTransaction

     command    = e.Command
     connection = command.Connection     
     connection.Open()     
     transaction = connection.BeginTransaction()
     command.Transaction = transaction

 End Sub 'On_Sql_Updating

 Sub On_Sql_Updated(ByVal source As Object, ByVal e As SqlDataSourceStatusEventArgs)

    Dim command As DbCommand
    Dim transaction As DbTransaction

    command = e.Command
    transaction = 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. 
    Dim OtherProcessSucceeded as Boolean = True

    If (OtherProcessSucceeded) Then
        transaction.Commit()
        Label2.Text="The record was updated successfully!"
    Else    
        transaction.Rollback()
        Label2.Text="The record was not updated."
    End If
 End Sub ' On_Sql_Updated
</script>

<html  >
  <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="On_Sql_Updating"
          OnUpdated ="On_Sql_Updated">
          <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>

<%@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  >
  <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>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), 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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Web.UI.WebControls Namespace

SqlDataSourceCommandEventHandler

Bibliothèque de classes .NET Framework

SqlDataSourceCommandEventArgs, classe

Fournit des données pour les événements Updating, Deleting et Inserting du contrôle SqlDataSource.

Hiérarchie d'héritage

Espace de noms : System.Web.UI.WebControls
Assembly : System.Web (dans System.Web.dll)

Syntaxe

Visual Basic

Public Class SqlDataSourceCommandEventArgs _
    Inherits CancelEventArgs

public class SqlDataSourceCommandEventArgs : CancelEventArgs

VisualC++

public ref class SqlDataSourceCommandEventArgs : public CancelEventArgs

type SqlDataSourceCommandEventArgs =  
    class
        inherit CancelEventArgs
    end

Le type SqlDataSourceCommandEventArgs expose les membres suivants.

Constructeurs

	Nom	Description
	SqlDataSourceCommandEventArgs	Initialise une nouvelle instance de la classe SqlDataSourceCommandEventArgs à l'aide de l'objet de commande de base de données spécifié.

Début

Propriétés

	Nom	Description
	Cancel	Obtient ou définit une valeur indiquant si l'événement doit être annulé. (Hérité de CancelEventArgs.)
	Command	Obtient la commande de base de données en attente.

Début

Méthodes

	Nom	Description
	Equals(Object)	Détermine si l'Object spécifié est égal à l'Object en cours. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de netto***ge avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actif. (Hérité de Object.)
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Notes

En ajoutant un délégué de gestionnaire d'événements pour gérer les événements Updating, Inserting ou Deleting, vous pouvez exécuter tout prétraitement supplémentaire requis ou annuler totalement la commande de base de données.

La classe SqlDataSourceCommandEventArgs étant dérivée de la classe CancelEventArgs, vous pouvez annuler une commande de base de données SqlDataSource en attente en attribuant la valeur true à la propriété Cancel. Vous pouvez examiner et manipuler CommandText, la collection Parameters et d'autres propriétés de commande avant d'exécuter la commande en accédant à l'objet DbCommand exposé par la propriété Command.

La classe SqlDataSourceCommandEventArgs est utilisée dans les méthodes OnUpdating, OnInserting et OnDeleting pour fournir l'accès à une commande de base de données SqlDataSource avant son exécution. Le contrôle SqlDataSource expose beaucoup d'événements que vous pouvez gérer pour travailler avec les objets de données sous-jacents pendant le déroulement d'une opération de données. Le tableau suivant répertorie les événements, ainsi que les EventArgs et les classes de gestionnaire d'événements associés, pour mieux vous guider vers les divers événements qui correspondent au cycle de vie d'une opération de données utilisant le contrôle SqlDataSource.

Événement	EventArgs	EventHandler
Selecting se produit avant la récupération des données.	SqlDataSourceSelectingEventArgs	SqlDataSourceSelectingEventHandler
Inserting, Updating, Deleting se produisent avant une opération d'insertion, de mise à jour ou de suppression.	SqlDataSourceCommandEventArgs	SqlDataSourceCommandEventHandler
Selected, Inserted, Updated, Deleted se produisent une fois terminées la récupération, l'insertion, la mise à jour ou la suppression des données.	SqlDataSourceStatusEventArgs	SqlDataSourceStatusEventHandler

Exemples

L'exemple de code suivant montre comment afficher les données récupérées d'une base de données Microsoft SQL Server dans un contrôle DropDownList et mettre à jour l'enregistrement à l'aide d'un contrôle TextBox. L'exemple vous montre comment utiliser un objet DbTransaction pour ajouter le contexte de transaction lors de l'utilisation du contrôle SqlDataSource afin de mettre à jour des données.

Visual Basic

<%@Page  Language="VB" %>
<%@Import Namespace="System.Data" %>
<%@Import Namespace="System.Data.Common" %>
<%@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">

 Sub On_Click(ByVal source As Object, ByVal e As EventArgs)
        SqlDataSource1.Update()
 End Sub 'On_Click

 Sub On_Sql_Updating(ByVal source As Object, ByVal e As SqlDataSourceCommandEventArgs)
     Dim command as DbCommand
     Dim connection as DbConnection
     Dim transaction as DbTransaction

     command    = e.Command
     connection = command.Connection     
     connection.Open()     
     transaction = connection.BeginTransaction()
     command.Transaction = transaction

 End Sub 'On_Sql_Updating

 Sub On_Sql_Updated(ByVal source As Object, ByVal e As SqlDataSourceStatusEventArgs)

    Dim command As DbCommand
    Dim transaction As DbTransaction

    command = e.Command
    transaction = 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. 
    Dim OtherProcessSucceeded as Boolean = True

    If (OtherProcessSucceeded) Then
        transaction.Commit()
        Label2.Text="The record was updated successfully!"
    Else    
        transaction.Rollback()
        Label2.Text="The record was not updated."
    End If
 End Sub ' On_Sql_Updated
</script>

<html  >
  <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="On_Sql_Updating"
          OnUpdated ="On_Sql_Updated">
          <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>

<%@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  >
  <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>

Informations de version

.NET Framework

Pris en charge dans : 4, 3.5, 3.0, 2.0

Plateformes

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

System.Web.UI.WebControls, espace de noms

SqlDataSourceCommandEventHandler

Mots clés

: Ajouter un mot clé

Contenu de la communauté

Ajouter du contenu

Annotations

Gérer votre profil | Contactez-nous | Newsletter MSDN