ObjectDataSource.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 by calling the method that is identified by the DeleteMethod property with any parameters that are in the DeleteParameters collection.

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

Public Function Delete As Integer

Return Value

Type: System.Int32

A value that represents the number of rows deleted from the underlying data storage, if the AffectedRows property of the ObjectDataSourceStatusEventArgs is set in the Deleted event; otherwise, -1.

Before the Delete operation is performed, the OnDeleting method is called to raise the Deleting event. You can handle the Deleting event to examine the values of the parameters and to perform any preprocessing before a Delete operation. To perform a delete operation, the ObjectDataSourceView object uses reflection to create an instance of the object that is identified by the TypeName property. It then calls the method that is identified by the DeleteMethod property, using any associated DeleteParameters properties. If the deletion parameters come from an associated data-bound control, the name of the parameters is created according to the OldValuesParameterFormatString property. After the Delete operation completes, the OnDeleted method is called to raise the Deleted event. You can handle the Deleted event to examine any return values, output parameters, and exceptions, and to perform any post-processing.

The Delete method delegates to the Delete method of the ObjectDataSourceView object that is associated with the ObjectDataSource control.

When the ObjectDataSource control is associated with a data-bound control, such as the GridView control, it is not necessary to call the Delete method from page code. The Delete method is invoked directly by the data-bound control instead.

For more information about parameter merging, object lifetime, and method resolution, see DeleteMethod.

.NET Framework
Available since 2.0
Return to top