SqlDataSourceSelectingEventArgs SqlDataSourceSelectingEventArgs SqlDataSourceSelectingEventArgs SqlDataSourceSelectingEventArgs Class

Definition

Provides data for the Selecting event of the SqlDataSource control.

public ref class SqlDataSourceSelectingEventArgs : System::Web::UI::WebControls::SqlDataSourceCommandEventArgs
public class SqlDataSourceSelectingEventArgs : System.Web.UI.WebControls.SqlDataSourceCommandEventArgs
type SqlDataSourceSelectingEventArgs = class
    inherit SqlDataSourceCommandEventArgs
Public Class SqlDataSourceSelectingEventArgs
Inherits SqlDataSourceCommandEventArgs
Inheritance

Remarks

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
Selecting.

Occurs before the data is retrieved.
SqlDataSourceSelectingEventArgs SqlDataSourceSelectingEventHandler
Inserting, Updating, and Deleting.

Occur before an insert, update, or delete operation is performed.
SqlDataSourceCommandEventArgs SqlDataSourceCommandEventHandler
Selected, Inserted, Updated, and Deleted.

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

Constructors

SqlDataSourceSelectingEventArgs(DbCommand, DataSourceSelectArguments) SqlDataSourceSelectingEventArgs(DbCommand, DataSourceSelectArguments) SqlDataSourceSelectingEventArgs(DbCommand, DataSourceSelectArguments) SqlDataSourceSelectingEventArgs(DbCommand, DataSourceSelectArguments)

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

Properties

Arguments Arguments Arguments Arguments

Gets the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments) method.

Cancel Cancel Cancel Cancel

Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
Command Command Command Command

Gets the pending database command.

(Inherited from SqlDataSourceCommandEventArgs)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also