SqlRowUpdatingEventArgs Class

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Provides data for the RowUpdating event.

public ref class SqlRowUpdatingEventArgs sealed : System::Data::Common::RowUpdatingEventArgs

public sealed class SqlRowUpdatingEventArgs : System.Data.Common.RowUpdatingEventArgs

type SqlRowUpdatingEventArgs = class
    inherit RowUpdatingEventArgs

Public NotInheritable Class SqlRowUpdatingEventArgs
Inherits RowUpdatingEventArgs

Inheritance

RowUpdatingEventArgs

SqlRowUpdatingEventArgs

Examples

The following example shows how to use both the RowUpdating and RowUpdated events.

The RowUpdating event returns this output:

event args: (command=Microsoft.Data.SqlClient.SQLCommand commandType=2 status=0)

The RowUpdated event returns this output:

event args: (command=Microsoft.Data.SqlClient.SQLCommand commandType=2 recordsAffected=1 row=System.Data.DataRow[37] status=0)

using Microsoft.Data.SqlClient;
using System.Xml;
using System.Data.Common;
using System.Windows.Forms;

public class Form1 : Form
{
    private DataSet DataSet1;
    private DataGrid dataGrid1;


    // handler for RowUpdating event
    private static void OnRowUpdating(object sender, SqlRowUpdatingEventArgs e)
    {
        PrintEventArgs(e);
    }

    //Handler for RowUpdated event.
    private static void OnRowUpdated(object sender, SqlRowUpdatedEventArgs e)
    {
        PrintEventArgs(e);
    }

    public static int Main()
    {
        const string CONNECTION_STRING = "Persist Security Info=False;Integrated Security=SSPI;database=northwind;server=mySQLServer";
        const string SELECT_ALL = "select * from Products";

        //Create DataAdapter.
        SqlDataAdapter rAdapter = new SqlDataAdapter(SELECT_ALL, CONNECTION_STRING);

        //Create and fill DataSet (Select only first 5 rows.).
        DataSet rDataSet = new DataSet();
        rAdapter.Fill(rDataSet, 0, 5, "Table");

        //Modify DataSet.
        DataTable rTable = rDataSet.Tables["Table"];
        rTable.Rows[0][1] = "new product";

        //Add handlers.
        rAdapter.RowUpdating += new SqlRowUpdatingEventHandler(OnRowUpdating);
        rAdapter.RowUpdated += new SqlRowUpdatedEventHandler(OnRowUpdated);

        //Update--this operation fires two events (RowUpdating and RowUpdated) for each changed row. 
        rAdapter.Update(rDataSet, "Table");

        //Remove handlers.
        rAdapter.RowUpdating -= new SqlRowUpdatingEventHandler(OnRowUpdating);
        rAdapter.RowUpdated -= new SqlRowUpdatedEventHandler(OnRowUpdated);
        return 0;
    }

    private static void PrintEventArgs(SqlRowUpdatingEventArgs args)
    {
        Console.WriteLine("OnRowUpdating");
        Console.WriteLine("  event args: (" +
            " command=" + args.Command +
            " commandType=" + args.StatementType +
            " status=" + args.Status + ")");
    }

    private static void PrintEventArgs(SqlRowUpdatedEventArgs args)
    {
        Console.WriteLine("OnRowUpdated");
        Console.WriteLine("  event args: (" +
            " command=" + args.Command +
            " commandType=" + args.StatementType +
            " recordsAffected=" + args.RecordsAffected +
            " status=" + args.Status + ")");
    }
}

Remarks

The RowUpdating event is raised before an Update to a row.

When you are using Update, there are two events that occur for each data row updated. The order of execution is as follows:

1. The values in the DataRow are moved to the parameter values.

2. The OnRowUpdating event is raised.

3. The command executes.

4. If the command is set to FirstReturnedRecord, and the first returned result is placed in the DataRow.

5. If there are output parameters, they are placed in the DataRow.

6. The OnRowUpdated event is raised.

7. AcceptChanges is called.

Constructors

SqlRowUpdatingEventArgs(DataRow, IDbCommand, StatementType, DataTableMapping)

Initializes a new instance of the SqlRowUpdatingEventArgs class.

Properties

Command

Gets or sets the SqlCommand to execute when performing the Update(DataSet).