Represents a special field that displays command buttons to perform selecting, editing, inserting, or deleting operations in a data-bound control.
See Also: CommandField Members
Syntax
Remarks
The System.Web.UI.WebControls.CommandField class is a special field used by data-bound controls (such as System.Web.UI.WebControls.GridView and System.Web.UI.WebControls.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.
| CommandField.ShowDeleteButton |
Shows or hides a Delete button in a System.Web.UI.WebControls.CommandField field for each record in the data-bound control. The Delete button allows the user to delete a record from the data source. |
| CommandField.ShowEditButton |
Shows or hides an Edit button in a System.Web.UI.WebControls.CommandField field 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. |
| CommandField.ShowInsertButton |
Shows or hides the New button in a System.Web.UI.WebControls.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. This property applies only to data-bound controls that support inserting operations, such as the System.Web.UI.WebControls.DetailsView control. |
| CommandField.ShowSelectButton |
Shows or hides a Select button in a System.Web.UI.WebControls.CommandField field 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 CommandField.ShowCancelButton property.
When a data-bound control is used in combination with a data source control (such as a System.Web.UI.WebControls.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 System.Web.UI.WebControls.CommandField field is displayed differently depending on the data-bound control in which it is used. For example, the System.Web.UI.WebControls.GridView control displays a System.Web.UI.WebControls.CommandField field as a column, while the System.Web.UI.WebControls.DetailsView control displays it as a row.
To specify the type of button to display, use the ButtonFieldBase.ButtonType property. When the ButtonFieldBase.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.
| CommandField.CancelText |
The caption for the Cancel button. |
| CommandField.DeleteText |
The caption for the Delete button. |
| CommandField.EditText |
The caption for the Edit button. |
| CommandField.InsertText |
The caption for the Insert button. This property applies only to data-bound controls that support insert operations, such as the System.Web.UI.WebControls.DetailsView control. |
| CommandField.NewText |
The caption for the New button. This property applies only to data-bound controls that support insert operations, such as the System.Web.UI.WebControls.DetailsView control. |
| CommandField.SelectText |
The caption for the Select button. |
| CommandField.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 ButtonFieldBase.ButtonType property to ButtonType.Image and then setting the properties shown in the following table.
| CommandField.CancelImageUrl |
The image to display for the Cancel button |
| CommandField.DeleteImageUrl |
The image to display for the Delete button. |
| CommandField.EditImageUrl |
The image to display for the Edit button. |
| CommandField.InsertText |
The image to display for the Insert button. This property applies only to data-bound controls that support insert operations, such as the System.Web.UI.WebControls.DetailsView control. |
| CommandField.NewImageUrl |
The image to display for the New button. This property applies only to data-bound controls that support insert operations, such as the System.Web.UI.WebControls.DetailsView control. |
| CommandField.SelectImageUrl |
The image to display for the Select button. |
| CommandField.UpdateImageUrl |
The image to display for the Update button. |
By default, when the user clicks a button in a System.Web.UI.WebControls.CommandField field, validation is performed on all validation controls on the page. To prevent validation from occurring when a button is clicked, set the CommandField.CausesValidation property to false.
You can hide a System.Web.UI.WebControls.CommandField field in a data-bound control by setting the DataControlField.Visible property to false.
The System.Web.UI.WebControls.CommandField field allows you to customize its header and footer sections. To display a caption in the header or the footer section, set the DataControlField.HeaderText or the DataControlField.FooterText property, respectively. Instead of displaying text in the header section, you can display an image by setting the DataControlField.HeaderImageUrl property. To hide the header section in a System.Web.UI.WebControls.CommandField object, set the ButtonFieldBase.ShowHeader property to false.
Some data-bound controls (such as the System.Web.UI.WebControls.GridView control) can show or hide only the entire header section of the control. These data-bound controls do not support the ButtonFieldBase.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 System.Web.UI.WebControls.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.
| DataControlField.ControlStyle |
The style settings for the child Web server controls of the System.Web.UI.WebControls.CommandField object. |
| DataControlField.FooterStyle |
The style settings for the footer section of the System.Web.UI.WebControls.CommandField object. |
| DataControlField.HeaderStyle |
The style settings for the header section of the System.Web.UI.WebControls.CommandField object. |
| DataControlField.ItemStyle |
The style settings for the data items in the System.Web.UI.WebControls.CommandField object. |
Requirements
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0