SqlDataSource.Delete Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Performs a delete operation using the DeleteCommand SQL string and any parameters that are in the DeleteParameters collection.

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

member Delete : unit -> int

Return Value

Type: System.Int32

A value that represents the number of rows deleted from the underlying database.

Exception Condition

The SqlDataSource cannot establish a connection with the underlying data source.

Before the delete operation is performed, the OnDeleting method is called to raise the Deleting event. You can handle this event to examine the values of the parameters and to perform any preprocessing before a delete operation.

After the operation completes, the OnDeleted method is called to raise the Deleted event. You can handle this event to examine any return values and error codes and to perform any post-processing.

The Delete method is provided for programmatic access to the Delete method. If the SqlDataSource control is associated with a data-bound control, the data-bound control automatically calls the Delete method.

The Delete method delegates to the Delete method of the SqlDataSourceView object that is associated with the SqlDataSource control. To perform the operation, the SqlDataSourceView builds a DbCommand object using the DeleteCommand text and any associated DeleteParameters values, and then executes the DbCommand against the underlying database.

The following code example demonstrates how to set the DeleteCommand text to delete an order from the Northwind database. Initially, data is retrieved from the Orders table and displayed in a DropDownList control. You must explicitly declare the DeleteParameters property and call the Delete method when using data-bound controls, such as the DropDownList (unlike other controls, such as GridView and DetailsView, which automatically populate the parameters and call the Delete method on a data source control). In this example, the OnClick event is delegated to the private OnDelete event handler, which explicitly calls the Delete method of the SqlDataSource control.

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

.NET Framework
Available since 2.0
Return to top