ObjectDataSourceView.ExecuteDelete Method (IDictionary, IDictionary)

.NET Framework (current version)

Note
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 DeleteMethod method and the specified keys and oldValues collection.

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

Syntax

C++

protected override int ExecuteDelete(
	IDictionary keys,
	IDictionary oldValues
)

Parameters

keys: Type: System.Collections.IDictionary
A IDictionary of parameters used with the DeleteMethod property to perform the delete operation. If there are no parameters associated with the method, pass null.

oldValues: Type: System.Collections.IDictionary
A IDictionary that contains row values that are evaluated, only if the ConflictDetection property is set to the CompareAllValues field.

Return Value

Type: System.Int32

The number of rows deleted; otherwise, -1, if the number is not known. For more information, see Delete.

Exceptions

Exception	Condition
NotSupportedException	The CanDelete property returns false.
InvalidOperationException	The ConflictDetection property is set to the CompareAllValues value, and no values are passed in the oldValues collection.

The ObjectDataSourceView class implements the inherited ExecuteDelete method to delete data from an underlying data store using a business object. Page developers and data-bound control authors do not call the ExecuteDelete method directly; instead, use the publicly exposed Delete method.

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 perform any preprocessing before the Delete method is called.

To perform a delete operation, the ObjectDataSourceView uses reflection to call the method that is identified by the DeleteMethod property and any associated parameters in the keys and oldValues collections, and then executes it. 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.

Version Information

.NET Framework
Available since 2.0