Edit

ObjectDataSourceView.Delete(IDictionary, IDictionary) Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Performs a delete operation by calling the business object method that is identified by the DeleteMethod property using the specified keys and oldValues collections.

public:
 int Delete(System::Collections::IDictionary ^ keys, System::Collections::IDictionary ^ oldValues);
public int Delete (System.Collections.IDictionary keys, System.Collections.IDictionary oldValues);
override this.Delete : System.Collections.IDictionary * System.Collections.IDictionary -> int
Public Function Delete (keys As IDictionary, oldValues As IDictionary) As Integer

Parameters

keys
IDictionary

A IDictionary of the key values used to identify the item to delete. These parameters are used with the DeleteMethod property to perform the delete operation. If there are no parameters associated with the method, pass null.

oldValues
IDictionary

A IDictionary that contains the additional non-key values used to match the item in the data source. Row values are passed to the method only if the ConflictDetection property is set to the CompareAllValues field.

Returns

Int32

The number of rows deleted; otherwise, -1, if the number is not known.

Remarks

The default value is -1, which means that an unknown number of rows were deleted. To return a different value, set the AffectedRows property of the ObjectDataSourceStatusEventArgs object of the Deleted event handler. The number of affected rows is typically returned by the Delete method for the business object, and that value is available from the ReturnValue property of the ObjectDataSourceStatusEventArgs parameter of the Deleted event handler.

The Delete method calls the ExecuteDelete method, passing the keys and oldValues collections.

Applies to

See also