GridViewCancelEditEventArgs Class

Note: This class is new in the .NET Framework version 2.0.

Provides data for the RowCancelingEdit event.

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

public ref class GridViewCancelEditEventArgs : public CancelEventArgs
public class GridViewCancelEditEventArgs extends CancelEventArgs
public class GridViewCancelEditEventArgs extends CancelEventArgs

The GridView control raises the RowCancelingEdit event when the Cancel button (a button with its CommandName property set to "Cancel") is clicked, but before exiting edit mode. This allows you to provide an event-handling method that performs a custom routine, such as stopping the cancel operation if it would put the row in an undesired state, whenever this event occurs.

A GridViewCancelEditEventArgs object is passed to the event-handling method, which allows you to determine the index of the row containing the Cancel button that raised the event and to indicate that the cancel operation should be stopped. To stop the cancel operation, set the Cancel property to true.

For more information about handling events, see Consuming Events.

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

The following example demonstrates how to use the GridViewCancelEditEventArgs object passed to the event-handling method to determine the index of the row containing the Cancel button clicked by the user.

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

  • AspNetHostingPermission  For operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
  • AspNetHostingPermission  For operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.GridViewCancelEditEventArgs

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

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: