Name

EditCommandColumn

Synopsis

The EditCommandColumn class is a special type of column used with the DataGrid control. It provides an “Edit” button or link (depending on the ButtonType property) that, when clicked, fires the DataGrid.EditCommand event. This event allows you to initiate editing for a row by using the DataGrid.EditItemIndex property (after which you must rebind to the data source).

While editing is in progress, the EditCommandColumn displays “Cancel” and “Update” buttons instead of an “Edit” button. These will trigger the DataGrid.CancelCommand and DataGrid.UpdateCommand events, respectively. In these events, you can add the code required to commit changes to the data source and cancel editing (by setting DataGrid.EditItemIndex to -1). Rebind to the data source before returning the page.

Note that you must provide values for the CancelText, EditText, and UpdateText properties (like “Cancel”, “Edit”, and “Update”). Otherwise, the associated command buttons will not appear in the column when editing is underway.

Public Class EditCommandColumn : Inherits DataGridColumn
' Public Constructors
   Public Sub New() 
' Public Instance Properties
   Overridable Public Property ButtonType As ButtonColumnType  
   Overridable Public Property CancelText As String  
   Overridable Public Property EditText As String  
   Overridable Public Property UpdateText As String  
' Public Instance Methods
   Overrides Public Sub InitializeCell( ByVal cell As TableCell, ByVal columnIndex As Integer, ByVal itemType ...

Get ASP.NET in a Nutshell now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.