Export (0) Print
Expand All

StateChangeEventArgs Class

Provides data for the state change event of a .NET Framework data provider.

System.Object
  System.EventArgs
    System.Data.StateChangeEventArgs

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)

public sealed class StateChangeEventArgs : EventArgs

The StateChangeEventArgs type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkStateChangeEventArgsInitializes a new instance of the StateChangeEventArgs class, when given the original state and the current state of the object.
Top

  NameDescription
Public propertySupported by the XNA FrameworkCurrentStateGets the new state of the connection. The connection object will be in the new state already when the event is fired.
Public propertySupported by the XNA FrameworkOriginalStateGets the original state of the connection.
Top

  NameDescription
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The data is used by the StateChange property of the OleDbConnection and the StateChange property of the SqlConnection.

The following example shows how to use the StateChange event within the SqlConnection class.

// Handler for OnStateChange event. 
protected static void OnStateChange(object sender,
    StateChangeEventArgs e)
{
    PrintEventArgs(e);
}

static void Main()
{
    FillDataSet();
}

static private void FillDataSet()
{
    string connectionString = GetConnectionString();
    string queryString =
        "SELECT ProductID, UnitPrice from dbo.Products;";

    // Create a DataAdapter. 
    using (SqlDataAdapter dataAdapter =
               new SqlDataAdapter(queryString, connectionString))
    {

        // Add the handlers.
        dataAdapter.SelectCommand.Connection.StateChange
            += new StateChangeEventHandler(OnStateChange);

        // Create a DataSet.
        DataSet dataSet = new DataSet();

        // Fill the DataSet, which fires several StateChange events.
        dataAdapter.Fill(dataSet, 0, 5, "Table");
    }
}

protected static void PrintEventArgs(StateChangeEventArgs args)
{
    Console.WriteLine("StateChangeEventArgs");
    Console.WriteLine("  OriginalState= {0} CurrentState= {1}",
        args.OriginalState, args.CurrentState);
}

static private string GetConnectionString()
{
    // To avoid storing the connection string in your code,  
    // you can retrieve it from a configuration file. 
    return "Data Source=(local);Initial Catalog=Northwind;"
        + "Integrated Security=true";
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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