This documentation is archived and is not being maintained.

SqlDataSourceSelectingEventArgs Class

Provides data for the Selecting event of the SqlDataSource control.


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

public class SqlDataSourceSelectingEventArgs : SqlDataSourceCommandEventArgs

The SqlDataSourceSelectingEventArgs type exposes the following members.

Public methodSqlDataSourceSelectingEventArgsInitializes a new instance of the SqlDataSourceSelectingEventArgs class, using the specified DbCommand object and any DataSourceSelectArguments passed to the Select method.

Public propertyArgumentsGets the DataSourceSelectArguments object passed to the Select method.
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyCommandGets the pending database command. (Inherited from SqlDataSourceCommandEventArgs.)

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 a hash function for a particular type. (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.)

By adding an event handler delegate to handle the Selecting event, you can perform any additional preprocessing required or cancel the database query entirely. Because the SqlDataSourceSelectingEventArgs class is derived from the SqlDataSourceCommandEventArgs class, you can cancel a pending SqlDataSource database query by setting the Cancel property to true. You can examine and manipulate the CommandText, Parameters collection, and other database query properties prior to running the query by accessing the DbCommand object exposed by the Command property. You can also examine the DataSourceSelectArguments object that is passed to the Select method by accessing the Arguments property.

The SqlDataSourceSelectingEventArgs class is used in the OnSelecting method to provide access to a SqlDataSource database query 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 classes and event handler delegates.





Occurs before the data is retrieved.



Inserting, Updating, and Deleting.

Occur before an insert, update, or delete operation is performed.



Selected, Inserted, Updated, and Deleted.

Occur after the data retrieval, insert, update, or delete operation completes.



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.

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