GridView.EditIndex Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the index of the row to edit.

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

abstract EditIndex : int with get, set
override EditIndex : int with get, set

Property Value

Type: System.Int32

The zero-based index of the row to edit. The default is -1, which indicates that no row is being edited.

Exception Condition
ArgumentOutOfRangeException

The specified index is less than -1.

The row index is zero-based (the first row is row zero).

This property is typically used only in the following scenarios, which involve handlers for specific events:

  • You want the GridView control to open in edit mode for a specific row the first time that the page is displayed. To do this, you can set the EditIndex property in the handler for the Load event of the Page class or of the GridView control.

  • You want to know which row was edited after the row was updated. To do this, you can retrieve the row index from the EditIndex property in the RowUpdated event handler.

  • You are binding the GridView control to a data source by setting the DataSource property programmatically. In this case you must set the EditIndex property in the RowEditing and RowCancelingEdit event handlers.

If you set the EditIndex property after a postback or in handlers for events that are raised later than the Load event, the GridView control might not enter edit mode for the specified row. If you read the value of this property in other event handlers, the index is not guaranteed to reflect the row that is being edited.

To determine which row the user has clicked an Edit button or hyperlink in before the GridView control enters edit mode, you can retrieve the row index from the NewEditIndex property of the GridViewEditEventArgs object in the RowEditing event handler.

To prevent the GridView control from entering edit mode after a user has clicked an Edit button or hyperlink, set the Cancel property of the GridViewEditEventArgs object to true in the RowEditing event handler.

The following example demonstrates how to use the EditIndex property to determine which row was updated after it was edited in a GridView control. A message is displayed to indicate that the update was successful.

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

.NET Framework
Available since 2.0
Return to top
Show: