Export (0) Print
Expand All

GridViewDeleteEventArgs Class

Provides data for the RowDeleting event.

System::Object
  System::EventArgs
    System.ComponentModel::CancelEventArgs
      System.Web.UI.WebControls::GridViewDeleteEventArgs

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

public ref class GridViewDeleteEventArgs : public CancelEventArgs

The GridViewDeleteEventArgs type exposes the following members.

  NameDescription
Public methodGridViewDeleteEventArgsInitializes a new instance of the GridViewDeleteEventArgs class.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyKeysGets a dictionary of field name/value pairs that represent the primary key of the row to delete.
Public propertyRowIndexGets the index of the row being deleted.
Public propertyValuesGets a dictionary of the non-key field name/value pairs for the row to delete.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The GridView control raises the RowDeleting event when a Delete button is clicked, but before the GridView control deletes the record. (A Delete button is a button control whose CommandName property is set to "Delete".) You can perform a custom routine whenever this event occurs, such as canceling the delete operation.

A GridViewDeleteEventArgs object is passed to the event handler. This enables you to determine the index of the row being deleted and to cancel the delete operation. To cancel the delete operation, set the Cancel property of the GridViewDeleteEventArgs object to true. You can also manipulate the Keys and Values collections before the values are passed to the data source.

For more information about how to handle events, see Consuming Events.

For a list of initial property values for an instance of GridViewDeleteEventArgs, see the GridViewDeleteEventArgs constructor.

The following example shows how to use the GridViewDeleteEventArgs object that is passed to the event handler. The code cancels the delete operation if the user tries to remove the last record from a GridView control.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft