System.Web.UI.WebControls.CheckBoxField Class

Represents a Boolean field that is displayed as a check box in a data-bound control.

See Also: CheckBoxField Members


public class CheckBoxField : BoundField


The System.Web.UI.WebControls.CheckBoxField class is used by data-bound controls (such as System.Web.UI.WebControls.GridView and System.Web.UI.WebControls.DetailsView) to display the value of a Boolean data field in a check box. The System.Web.UI.WebControls.CheckBoxField object 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.CheckBoxField object as a column, while the System.Web.UI.WebControls.DetailsView control displays it as a row.


A check box is disabled (read-only) until the data-bound control displays a record that contains the check box in edit mode. For more information on how to put a record into edit mode, see the documentation for the parent control that contains the System.Web.UI.WebControls.CheckBoxField object.

To specify the field to display in a System.Web.UI.WebControls.CheckBoxField object, set the BoundField.DataField property with the field's name.


Because a check box can display only a selected or an unselected state, a System.Web.UI.WebControls.CheckBoxField object can be bound only to a field with a Boolean data type or a string that can be parsed by bool.Parse(string).

You can display a caption next to each check box by setting the CheckBoxField.Text property. A System.Web.UI.WebControls.CheckBoxField object is hidden in a data-bound control when the DataControlField.Visible property is set to false. To prevent the value of a field from being modified in edit mode, set the BoundField.ReadOnly property to true. In data-bound controls that support inserting records (such as the System.Web.UI.WebControls.DetailsView control), you can hide a System.Web.UI.WebControls.CheckBoxField object in insert mode by setting the DataControlField.InsertVisible property to false.

You can customize the header and footer sections of a System.Web.UI.WebControls.CheckBoxField object. To display a caption in the header or footer sections, set the DataControlField.HeaderText or DataControlField.FooterText properties, respectively. Instead of displaying text in the header section, you can display an image by setting the DataControlField.HeaderImageUrl property. The header section can be hidden in the System.Web.UI.WebControls.CheckBoxField object by setting the DataControlField.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 DataControlField.ShowHeader property for an individual bound 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.CheckBoxField 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.


The style settings for the child Web server controls of the System.Web.UI.WebControls.CheckBoxField object.


The style settings for the footer section of the System.Web.UI.WebControls.CheckBoxField object.


The style settings for the header section of the System.Web.UI.WebControls.CheckBoxField object.


The style settings for the data items in the System.Web.UI.WebControls.CheckBoxField object.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0