GridViewDeletedEventArgs Class

.NET Framework (current version)

Other Versions

Provides data for the RowDeleted event.

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

Inheritance Hierarchy

System::Object
System::EventArgs
System.Web.UI.WebControls::GridViewDeletedEventArgs

Syntax

C++

public ref class GridViewDeletedEventArgs : EventArgs

Constructors

	Name	Description
	GridViewDeletedEventArgs(Int32, Exception^)	Initializes a new instance of the GridViewDeletedEventArgs class.

Properties

	Name	Description
	AffectedRows	Gets the number of rows affected by the delete operation.
	Exception	Gets the exception (if any) that was raised during the delete operation.
	ExceptionHandled	Gets or sets a value indicating whether an exception that was raised during the delete operation was handled in the event handler.
	Keys	Gets an ordered dictionary of key field name/value pairs for the deleted record.
	Values	Gets a dictionary of the non-key field name/value pairs for the deleted record.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

The GridView control raises the RowDeleted event when a Delete button (a button with its CommandName property set to "Delete") within the control is clicked, but after the GridView control deletes the record. This allows you to provide an event-handling method that performs a custom routine, such as checking the results of a delete operation, whenever this event occurs.

A GridViewDeletedEventArgs object is passed to the event-handling method, which allows you to determine the number of records affected and any exceptions that might have occurred. To determine the number of records affected by the delete operation, use the AffectedRows property. Use the Exception property to determine whether any exceptions occurred. You can also indicate whether the exception was handled in the event-handling method by setting the ExceptionHandled property.

Note
If an exception occurs during the delete operation and the ExceptionHandled property is set to false, the GridView control re-throws the exception.

If you want to access the name/value pairs of the key fields and non-key fields of the deleted record, use the Keys and Values properties, respectively.

For more information about handling events, see NIB: Consuming Events.

Examples

The following example demonstrates how to use the GridViewDeletedEventArgs object passed to the event-handling method for the RowDeleted event to determine whether an exception occurred during a delete operation.

C++

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

Version Information

.NET Framework
Available since 2.0

Thread Safety

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