CheckBoxField Class

Note: This class is new in the .NET Framework version 2.0.

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

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

public class CheckBoxField : BoundField
public class CheckBoxField extends BoundField
public class CheckBoxField extends BoundField

The CheckBoxField class is used by data-bound controls (such as GridView and DetailsView) to display the value of a Boolean data field in a check box. The CheckBoxField object is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays a CheckBoxField object as a column, while the 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 CheckBoxField object.

To specify the field to display in a CheckBoxField object, set the DataField property with the field's name.


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

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

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


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 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 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.

Style property



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


The style settings for the footer section of the CheckBoxField object.


The style settings for the header section of the CheckBoxField object.


The style settings for the data items in the CheckBoxField object.

The following code example demonstrates how to use a CheckBoxField object in a GridView control to display a field from a Microsoft SQL Server data source with a Boolean data type.

<%@ Page language="C#" %>

    <form runat="server">
      <h3>CheckBoxField Example</h3>

      <asp:gridview id="AuthorsGridView" 
          <asp:boundfield datafield="au_lname"
            headertext="Last Name"/>
          <asp:checkboxfield datafield="contract"
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname], [address], [city], [state], [zip], [contract] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"

  • AspNetHostingPermission  for using a CheckBoxField object in a hosted environment. Associated enumeration value: AspNetHostingPermissionLevel.Minimal

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0