ListViewEditEventArgs.xml

<Type Name="ListViewEditEventArgs" FullName="System.Web.UI.WebControls.ListViewEditEventArgs">
  <TypeSignature Language="C#" Value="public class ListViewEditEventArgs : System.ComponentModel.CancelEventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ListViewEditEventArgs extends System.ComponentModel.CancelEventArgs" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.ListViewEditEventArgs" />
  <TypeSignature Language="VB.NET" Value="Public Class ListViewEditEventArgs&#xA;Inherits CancelEventArgs" />
  <TypeSignature Language="F#" Value="type ListViewEditEventArgs = class&#xA;    inherit CancelEventArgs" />
  <TypeSignature Language="C++ CLI" Value="public ref class ListViewEditEventArgs : System::ComponentModel::CancelEventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Web.Extensions</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.CancelEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides data for the <see cref="E:System.Web.UI.WebControls.ListView.ItemEditing" /> event.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 The <xref:System.Web.UI.WebControls.ListView> control raises the <xref:System.Web.UI.WebControls.ListView.ItemEditing> event when an Edit button is clicked, but before the <xref:System.Web.UI.WebControls.ListView> item enters edit mode. (An Edit button is a button whose `CommandName` property set to "Edit".) This enables you to provide an event-handling method that performs a custom routine whenever this event occurs, such as canceling the edit operation.

 A <xref:System.Web.UI.WebControls.ListViewEditEventArgs> object is passed to the event-handling method. This object enables you to determine the index of the item that is being edited, and to indicate that the edit operation should be canceled. To cancel the edit operation, set the <xref:System.ComponentModel.CancelEventArgs.Cancel%2A> property of the <xref:System.Web.UI.WebControls.ListViewEditEventArgs> object to `true`.

 For a list of initial property values for an instance of <xref:System.Web.UI.WebControls.ListViewEditEventArgs>, see the <xref:System.Web.UI.WebControls.ListViewEditEventArgs.%23ctor%2A> constructor.



## Examples
 The following example shows how to use the <xref:System.Web.UI.WebControls.ListViewEditEventArgs> object to cancel the edit operation when the user tries to update a discontinued item.

> [!IMPORTANT]
>  This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).

 [!code-aspx-csharp[System.Web.UI.WebControls.ListView.ItemEditing#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControls.ListView.ItemEditing/CS/ListViewItemEditingCS.aspx#1)]
 [!code-aspx-vb[System.Web.UI.WebControls.ListView.ItemEditing#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControls.ListView.ItemEditing/VB/ListViewItemEditingVB.aspx#1)]

 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.ListView" />
    <altmember cref="E:System.Web.UI.WebControls.ListView.ItemEditing" />
    <related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/bb398790(v=vs.100)">Technology Overview: The ListView Control</related>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ListViewEditEventArgs (int newEditIndex);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 newEditIndex) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.ListViewEditEventArgs.#ctor(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (newEditIndex As Integer)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.WebControls.ListViewEditEventArgs : int -&gt; System.Web.UI.WebControls.ListViewEditEventArgs" Usage="new System.Web.UI.WebControls.ListViewEditEventArgs newEditIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ListViewEditEventArgs(int newEditIndex);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="newEditIndex" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="newEditIndex">The index of the item to edit.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.ListViewEditEventArgs" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
 Use this constructor to initialize a new instance of the <xref:System.Web.UI.WebControls.ListViewEditEventArgs> class.

> [!NOTE]
>  This constructor is primarily used by control developers when they raise events.

 The following table shows the initial property value for an instance of <xref:System.Web.UI.WebControls.ListViewEditEventArgs>.

|Property|Initial value|
|--------------|-------------------|
|<xref:System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex%2A>|The value of the `newEditIndex` parameter.|

 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex" />
        <related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/bb398790(v=vs.100)">Technology Overview: The ListView Control</related>
      </Docs>
    </Member>
    <Member MemberName="NewEditIndex">
      <MemberSignature Language="C#" Value="public int NewEditIndex { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 NewEditIndex" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property NewEditIndex As Integer" />
      <MemberSignature Language="F#" Value="member this.NewEditIndex : int" Usage="System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int NewEditIndex { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the index of the item that is being edited.</summary>
        <value>The index of the item that is being edited.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
 Use the <xref:System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex%2A> property to determine the index of the item that is being edited. The item index is often used to retrieve this item from the <xref:System.Web.UI.WebControls.ListView.Items%2A> collection of the <xref:System.Web.UI.WebControls.ListView> control, which enables you to access the item's properties.



## Examples
 The following example shows how to use the <xref:System.Web.UI.WebControls.ListViewEditEventArgs.NewEditIndex%2A> property to retrieve the <xref:System.Web.UI.WebControls.ListViewItem> object that is being edited. This code example is part of a larger example provided for the <xref:System.Web.UI.WebControls.ListViewEditEventArgs> class.

 [!code-csharp[System.Web.UI.WebControls.ListView.ItemEditing#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControls.ListView.ItemEditing/CS/ListViewItemEditingCS.aspx#2)]
 [!code-vb[System.Web.UI.WebControls.ListView.ItemEditing#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControls.ListView.ItemEditing/VB/ListViewItemEditingVB.aspx#2)]

 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.ListView" />
        <altmember cref="P:System.Web.UI.WebControls.ListView.Items" />
        <altmember cref="T:System.Web.UI.WebControls.ListViewItem" />
        <altmember cref="P:System.ComponentModel.CancelEventArgs.Cancel" />
        <related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/bb398790(v=vs.100)">Technology Overview: The ListView Control</related>
      </Docs>
    </Member>
  </Members>
</Type>