System.Web 2.0.0.0 System.Web.UI.WebControls.BoundField

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

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

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

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

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

Some data-bound controls (such as the control) can show or hide only the entire header section of the control. These data-bound controls do not support the 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 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

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

The style settings for the footer section of the object.

The style settings for the header section of the object.

The style settings for the data items in the object.

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

- Constructor

  Use this constructor to initialize a new instance of the class. This constructor is commonly used when adding fields to a dynamically created data-bound control.

  To dynamically add a object to a data-bound control, create a new object, set its properties, and then add it to the data-bound control's field collection. For example, if you are using the control, add the object to the collection.

  Although you can dynamically add fields to a data-bound control, it is strongly recommended that all fields be statically declared and then shown or hidden, as appropriate. Statically declaring all your fields reduces the size of the view state for the parent data-bound control.

  Initializes a new instance of the class.

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
  System.Boolean To be added.

  The property is inherited from the class, but is not applicable to the class. Any attempt to access the value of this property will throw a exception.

  Overrides the property. This property is not supported by the class.

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
  System.Boolean To be added.

  The property is inherited from the class, but is not applicable to the class. Any attempt to access the value of this property will throw a exception.

  Overrides the property. This property is not supported by the class.

  2.0.0.0
- Method
  System.Void ``

  The method is a helper method used by the method to copy the properties of the current object to the object created by the method.

  Copies the properties of the current object to the specified object.

  The to copy the properties of the current to. 2.0.0.0
- Method
  System.Web.UI.WebControls.DataControlField

  The method is a helper method used by the method to create an empty object to which the properties of the current object can be copied.

  Creates an empty object.

  An empty .

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
  System.String To be added.

  The property is inherited from the class, but is not applicable to the class. Any attempt to access the value of this property will throw a exception.

  Gets or sets the string that specifies the display format for the value of the field. This property is not supported by the class.

  2.0.0.0
- Method
  System.Void `` `` `` ``

  The method is provided as a convenient way to retrieve the values of the fields from the specified object in a object.

  This method is used primarily by control developers.

  This method does not have a return value. Instead, the field values are returned by reference through the object passed in for the parameter. After the method has been called, iterate through the object to access the field values.

  If the object contains read-only field values, you must pass in true for the parameter to include those values.

  Fills the specified object with the values from the specified object.

  A used to store the values of the specified cell. The that contains the values to retrieve. One of the values. true to include the values of read-only fields; otherwise, false. 2.0.0.0
- Method
  System.Object

  The method is a helper method used to determine what value to display for a field when rendering the object in a designer. If real data can not be retrieved from the data source at design time, the value returned by this method is displayed instead.

  Retrieves the value used for the field's value when rendering the object in a designer.

  Always returns true.

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
  System.Boolean To be added.

  The property is inherited from the class, but is not applicable to the class. Any attempt to access the value of this property will throw a exception.

  Overrides the property. This property is not supported by the class.

  2.0.0.0
- Method
  System.Void `` ``

  The method is a helper method used to initialize a cell in the object.

  Initializes the specified object to the specified row state.

  The to initialize. One of the values. 2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
  System.String To be added.

  The property is inherited from the class, but is not applicable to the class. Any attempt to access the value of this property will throw a exception.

  Gets or sets the text displayed for a field when the field's value is null. This property is not supported by the class.

  2.0.0.0
- Method
  System.Void `` ``

  The method is a helper method used to bind the value of a field in the data source to a corresponding check box in the object.

  Binds the value of a field to a check box in the object.

  The source of the event. An that contains the event data. 2.0.0.0
- Property
  System.Boolean To be added.

  HTML encoding is not supported for this control, and this property always returns false.

  Gets a Boolean value indicating whether the control supports HTML encoding.

  2.0.0.0
- Property
  System.ComponentModel.DefaultValue("")
  System.ComponentModel.Localizable(true)
  System.String To be added.

  The property is used to display a caption next to each check box in a object. If the property is set to an empty string, no caption is displayed.

  All check boxes in the object share the same caption.

  The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.

  Gets or sets the caption to display next to each check box in a object.

  2.0.0.0