GridViewCancelEditEventHandler.xml

<Type Name="GridViewCancelEditEventHandler" FullName="System.Web.UI.WebControls.GridViewCancelEditEventHandler">
  <TypeSignature Language="C#" Value="public delegate void GridViewCancelEditEventHandler(object sender, GridViewCancelEditEventArgs e);" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed GridViewCancelEditEventHandler extends System.MulticastDelegate" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.GridViewCancelEditEventHandler" />
  <TypeSignature Language="VB.NET" Value="Public Delegate Sub GridViewCancelEditEventHandler(sender As Object, e As GridViewCancelEditEventArgs)" />
  <TypeSignature Language="F#" Value="type GridViewCancelEditEventHandler = delegate of obj * GridViewCancelEditEventArgs -&gt; unit" />
  <TypeSignature Language="C++ CLI" Value="public delegate void GridViewCancelEditEventHandler(System::Object ^ sender, GridViewCancelEditEventArgs ^ e);" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Delegate</BaseTypeName>
  </Base>
  <Parameters>
    <Parameter Name="sender" Type="System.Object" />
    <Parameter Name="e" Type="System.Web.UI.WebControls.GridViewCancelEditEventArgs" />
  </Parameters>
  <ReturnValue>
    <ReturnType>System.Void</ReturnType>
  </ReturnValue>
  <Docs>
    <param name="sender">The source of the event.</param>
    <param name="e">A <see cref="T:System.Web.UI.WebControls.GridViewCancelEditEventArgs" /> object that contains the event data.</param>
    <summary>Represents the method that handles the <see cref="E:System.Web.UI.WebControls.GridView.RowCancelingEdit" /> event of a <see cref="T:System.Web.UI.WebControls.GridView" /> control.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.GridView.RowCancelingEdit> event is raised when the Cancel button of a row in edit mode is clicked, but before the row exits 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.  
  
 When you create a <xref:System.Web.UI.WebControls.GridViewCancelEditEventHandler> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see [Handling and Raising Events](/dotnet/standard/events/).  
  
   
  
## Examples  
 The following example demonstrates how to programmatically add a <xref:System.Web.UI.WebControls.GridViewCancelEditEventHandler> delegate to the <xref:System.Web.UI.WebControls.GridView.RowCancelingEdit> event of a <xref:System.Web.UI.WebControls.GridView> control.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/GridViewCancelEditEventHandler/CS/gridviewcancelediteventhandlercs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/GridViewCancelEditEventHandler/VB/gridviewcancelediteventhandlervb.aspx" id="Snippet1":::  
  
 The following example demonstrates how to declaratively add a <xref:System.Web.UI.WebControls.GridViewCancelEditEventHandler> delegate to the <xref:System.Web.UI.WebControls.GridView.RowCancelingEdit> event of a <xref:System.Web.UI.WebControls.GridView> control.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/GridViewRowCancellingEdit/CS/gridviewrowcancellingeditcs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/GridViewRowCancellingEdit/VB/gridviewrowcancellingeditvb.aspx" id="Snippet1":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.GridView" />
    <altmember cref="T:System.Web.UI.WebControls.GridViewCancelEditEventArgs" />
    <altmember cref="E:System.Web.UI.WebControls.GridView.RowCancelingEdit" />
    <altmember cref="M:System.Web.UI.WebControls.GridView.OnRowCancelingEdit(System.Web.UI.WebControls.GridViewCancelEditEventArgs)" />
  </Docs>
</Type>