SqlDataSourceSelectingEventArgs Class
Provides data for the Selecting event of the SqlDataSource control.
Assembly: System.Web (in System.Web.dll)
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.SqlDataSourceCommandEventArgs
System.Web.UI.WebControls.SqlDataSourceSelectingEventArgs
| Name | Description | |
|---|---|---|
 | SqlDataSourceSelectingEventArgs(DbCommand, DataSourceSelectArguments) | Initializes a new instance of the SqlDataSourceSelectingEventArgs class, using the specified DbCommand object and any DataSourceSelectArguments passed to the Select method. |
| Name | Description | |
|---|---|---|
 | Arguments | Gets the DataSourceSelectArguments object passed to the Select method. |
| Cancel | Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.) |
| Command | Gets the pending database command.(Inherited from SqlDataSourceCommandEventArgs.) |
| 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 the default hash function. (Inherited from Object.) |
| GetType() | |
| MemberwiseClone() | |
| ToString() | Returns 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.
Event | EventArgs | EventHandler |
|---|---|---|
Occurs before the data is retrieved. | SqlDataSourceSelectingEventArgs | |
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. |
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.