EditCommandColumn Class

.NET Framework (current version)

Other Versions

A special column type for the DataGrid control that contains the Edit buttons for editing data items in each row.

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

Inheritance Hierarchy

System.Object
System.Web.UI.WebControls.DataGridColumn
System.Web.UI.WebControls.EditCommandColumn

Syntax

C++

type EditCommandColumn = 
    class
        inherit DataGridColumn
    end

Constructors

	Name	Description
	EditCommandColumn()	Initializes a new instance of the EditCommandColumn class.

Properties

	Name	Description
	ButtonType	Gets or sets the button type for the column.
	CancelText	Gets or sets the text to display for the Cancel command button in the EditCommandColumn.
	CausesValidation	Gets or sets a value indicating whether validation is performed when an Update button in the EditCommandColumn object is clicked.
	DesignMode	Gets a value that indicates whether the column is in design mode.(Inherited from DataGridColumn.)
	EditText	Gets or sets the text to display for the Edit button in the EditCommandColumn.
	FooterStyle	Gets the style properties for the footer section of the column.(Inherited from DataGridColumn.)
	FooterText	Gets or sets the text displayed in the footer section of the column.(Inherited from DataGridColumn.)
	HeaderImageUrl	Gets or sets the location of an image to display in the header section of the column.(Inherited from DataGridColumn.)
	HeaderStyle	Gets the style properties for the header section of the column.(Inherited from DataGridColumn.)
	HeaderText	Gets or sets the text displayed in the header section of the column.(Inherited from DataGridColumn.)
	IsTrackingViewState	Gets a value that determines whether the DataGridColumn object is marked to save its state.(Inherited from DataGridColumn.)
	ItemStyle	Gets the style properties for the item cells of the column.(Inherited from DataGridColumn.)
	Owner	Gets the DataGrid control that the column is a member of.(Inherited from DataGridColumn.)
	SortExpression	Gets or sets the name of the field or expression to pass to the OnSortCommand method when a column is selected for sorting.(Inherited from DataGridColumn.)
	UpdateText	Gets or sets the text to display for the Update command button in the EditCommandColumn.
	ValidationGroup	Gets or sets the group of validation controls for which the EditCommandColumn object causes validation when it posts back to the server.
	ViewState	Gets the System.Web.UI.StateBag object that allows a column derived from the DataGridColumn class to store its properties.(Inherited from DataGridColumn.)
	Visible	Gets or sets a value that indicates whether the column is visible in the DataGrid control.(Inherited from DataGridColumn.)

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Initialize()	Provides the base implementation to reset a column derived from the DataGridColumn class to its initial state.(Inherited from DataGridColumn.)
	InitializeCell(TableCell, Int32, ListItemType)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a cell within the column.(Overrides DataGridColumn.InitializeCell(TableCell, Int32, ListItemType).)
	LoadViewState(Object)	Loads the state of the DataGridColumn object.(Inherited from DataGridColumn.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnColumnChanged()	Calls the DataGridDesigner.OnColumnsChanged method.(Inherited from DataGridColumn.)
	SaveViewState()	Saves the current state of the DataGridColumn object.(Inherited from DataGridColumn.)
	ToString()	Returns the string representation of the column.(Inherited from DataGridColumn.)
	TrackViewState()	Causes tracking of view-state changes to the server control so they can be stored in the server control's System.Web.UI.StateBag object.(Inherited from DataGridColumn.)

Explicit Interface Implementations

	Name	Description
	IStateManager.LoadViewState(Object)	This API supports the product infrastructure and is not intended to be used directly from your code. Loads previously saved state.(Inherited from DataGridColumn.)
	IStateManager.SaveViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object containing state changes.(Inherited from DataGridColumn.)
	IStateManager.TrackViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from DataGridColumn.)
	IStateManager.IsTrackingViewState	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the column is tracking view state changes.(Inherited from DataGridColumn.)

Use the EditCommandColumn class to create a special column for the DataGrid control that contains the Edit, Update, and Cancel buttons for each data row in the grid. These buttons allow you to edit the values of a row in the DataGrid control.

If no row is selected, an Edit button displays in the EditCommandColumn object for each data row in the DataGrid control. When the Edit button for an item is clicked, the EditCommand event is raised and the Edit button is replaced with the Update and Cancel buttons. You need to provide code to handle the EditCommand event. A typical event handler sets the EditItemIndex property to the selected row, and then rebinds the data to the DataGrid control.

Note
You must provide values for the CancelText, EditText, and UpdateText properties. Otherwise, the associated buttons will not appear in the EditCommandColumn.

The buttons in the EditCommandColumn can be set to display as hyperlinks or push buttons by setting the ButtonType property.

Clicking the Update or Cancel button raises the UpdateCommand or CancelCommand event, respectively. You need to provide code to handle these events.

A typical handler for the UpdateCommand event updates the data, sets the EditItemIndex property to -1 (to deselect the item), and then rebinds the data to the DataGrid control.

A typical handler for the CancelCommand event sets the EditItemIndex property to -1 (to deselect the item), and then rebinds the data to the DataGrid control.

Caution
The EditCommandColumn object can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a DataGrid control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see Securing Standard Controls, How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Validating User Input in ASP.NET Web Pages.

Caution

The EditCommandColumn object can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a DataGrid control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see Securing Standard Controls, How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Validating User Input in ASP.NET Web Pages.

By default, page validation is performed when an Update button in the EditCommandColumn control is clicked. Page validation determines whether the input controls that are associated with a validation control on the page all pass the validation rules that are specified by the validation control. To prevent page validation from occurring, set the CausesValidation property to false.