System.Web.UI.WebControls Namespace

---

.NET Framework version 2.0

Represents a special field that displays command buttons to perform selecting, editing, inserting, or deleting operations in a data-bound control.

CommandField Class Members

Show Inherited Members

Constructors Visibility Constructor Parameters public CommandField ( )   Properties Visibility Name Value Type Accessibility public CancelImageUrl String [ Get , Set ] public CancelText String [ Get , Set ] public CausesValidation Boolean [ Get , Set ] public DeleteImageUrl String [ Get , Set ] public DeleteText String [ Get , Set ] public EditImageUrl String [ Get , Set ] public EditText String [ Get , Set ] public InsertImageUrl String [ Get , Set ] public InsertText String [ Get , Set ] public NewImageUrl String [ Get , Set ] public NewText String [ Get , Set ] public SelectImageUrl String [ Get , Set ] public SelectText String [ Get , Set ] public ShowCancelButton Boolean [ Get , Set ] public ShowDeleteButton Boolean [ Get , Set ] public ShowEditButton Boolean [ Get , Set ] public ShowInsertButton Boolean [ Get , Set ] public ShowSelectButton Boolean [ Get , Set ] public UpdateImageUrl String [ Get , Set ] public UpdateText String [ Get , Set ]   Methods Visibility Name Parameters Return Type protected CopyProperties ( DataControlField newField ) Void protected CreateField ( ) DataControlField public InitializeCell ( DataControlFieldCell cell , DataControlCellType cellType , DataControlRowState rowState , Int32 rowIndex ) Void public ValidateSupportsCallback ( ) Void

The CommandField class is a special field used by data-bound controls ( such as GridView and DetailsView ) to display command buttons that perform delete, edit, insert, or select operations. The command buttons to perform these operations can be shown or hidden using the properties shown in the following table.

Property	Description
ShowDeleteButton	Shows or hides a Delete button in a CommandField for each record in the data-bound control. The Delete button allows the user to delete a record from the data source.
ShowEditButton	Shows or hides an Edit button in a CommandField for each record in the data-bound control. The Edit button allows the user to edit a record from the data source. When the user clicks the Edit button for a specific record, that Edit button is replaced with an Update button and a Cancel button. All other command buttons are also hidden.
ShowInsertButton	Shows or hides the New button in a CommandField field. The New button allows the user to insert a new record in the data source. When the user clicks the New button, it is replaced with an Insert button and a Cancel button. All other command buttons are also hidden. NOTE: This property applies only to data-bound controls that support inserting operations, such as the DetailsView control.
ShowSelectButton	Shows or hides a Select button in a CommandField for each record in the data-bound control. The Select button allows the user to select a record in the data-bound control.

In addition, the Cancel button displayed when a record is in edit or insert mode can be shown or hidden by setting the ShowCancelButton property.

NOTE: When a data-bound control is used in combination with a data source control ( such as a SqlDataSource control ), the data-bound control can take advantage of the data source control's capabilities and provide automatic delete, update, and insert functionality. For other data sources, you need to provide the routines to perform these operations during the appropriate events for the data-bound control.

The CommandField is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays a CommandField as a column, while the DetailsView control displays it as a row.

To specify the type of button to display, use the ButtonType property. When the ButtonType property is set to ButtonType.Button or ButtonType.Link, you can specify the text to display for the buttons by setting the properties shown in the following table.

Property	Description
CancelText	The caption for the Cancel button.
DeleteText	The caption for the Delete button.
EditText	The caption for the Edit button.
InsertText	The caption for the Insert button. NOTE: This property applies only to data-bound controls that support insert operations, such as the DetailsView control.
NewText	The caption for the New button. NOTE: This property applies only to data-bound controls that support insert operations, such as the DetailsView control.
SelectText	The caption for the Select button.
UpdateText	The caption for the Update button.

Instead of displaying a command button or a link button, you can display an image button by setting the ButtonType property to ButtonType.Image and then setting the properties shown in the following table.

Property	Description
CancelImageUrl	The image to display for the Cancel button
DeleteImageUrl	The image to display for the Delete button.
EditImageUrl	The image to display for the Edit button.
InsertImageUrl	The image to display for the Insert button. NOTE: This property applies only to data-bound controls that support insert operations, such as the DetailsView control.
NewImageUrl	The image to display for the New button. NOTE: This property applies only to data-bound controls that support insert operations, such as the DetailsView control.
SelectImageUrl	The image to display for the Select button.
UpdateImageUrl	The image to display for the Update button.

By default, when the user clicks a button in a CommandField field, validation is performed on all validation controls on the page. To prevent validation from occurring when a button is clicked, set the CausesValidation property to false.

You can hide a CommandField in a data-bound control by setting the Visible property to false.

The CommandField allows you to customize its header and footer sections. To display a caption in the header or the footer section, set the HeaderText or the FooterText property, respectively. Instead of displaying text in the header section, you can display an image by setting the HeaderImageUrl property. To hide the header section in a CommandField object, set the ShowHeader property to false.

NOTE: Some data-bound controls ( such as the GridView control ) can show or hide only the entire header section of the control. These data-bound controls do not support the ShowHeader property for an individual button field. To show or hide the entire header section of a data-bound control ( if available ), use the control's ShowHeader property.

You also can customize the appearance of the CommandField object ( font color, background color, and so on ) by setting the style properties for the different parts of the field. The following table lists the different style properties.

Style property	Description
ControlStyle	The style settings for the child Web server controls of the CommandField object.
FooterStyle	The style settings for the footer section of the CommandField object.
HeaderStyle	The style settings for the header section of the CommandField object.
ItemStyle	The style settings for the data items in the CommandField object.

BoundField   ButtonField   CheckBoxField   HyperLinkField   ImageField   TemplateField

Suggested Reading