Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SqlDataSourceCommandEventArgs Class

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

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
type SqlDataSourceCommandEventArgs =  
    class 
        inherit CancelEventArgs 
    end

The SqlDataSourceCommandEventArgs type exposes the following members.

  NameDescription
Public methodSqlDataSourceCommandEventArgsInitializes a new instance of the SqlDataSourceCommandEventArgs class, using the specified database command object.
Top
  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyCommandGets the pending database command.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, 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. All rights reserved.