System.Web.UI.WebControls.BoundField Class

Represents a field that is displayed as text in a data-bound control.

See Also: BoundField Members

Syntax

public class BoundField : DataControlField

Remarks

The System.Web.UI.WebControls.BoundField 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 field as text. The System.Web.UI.WebControls.BoundField 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.BoundField object as a column, while the System.Web.UI.WebControls.DetailsView control displays it as a row.

To specify the field to display in a System.Web.UI.WebControls.BoundField object, set the BoundField.DataField property to the field's name. The field's value can be HTML-encoded before it is displayed by setting the BoundField.HtmlEncode property to true. You can apply a custom formatting string to the field's value by setting the BoundField.DataFormatString property. When the BoundField.HtmlEncode property is true, the encoded string value of the field is used in the custom format string. By default, the formatting string is applied to field values only when the data-bound control is in read-only mode. To apply the formatting string to values displayed while the data-bound control is in edit mode, set the BoundField.ApplyFormatInEditMode property to true. If a field's value is null, you can display a custom caption by setting the BoundField.NullDisplayText property. The System.Web.UI.WebControls.BoundField object can also automatically convert empty string ("") field values to null values by setting the BoundField.ConvertEmptyStringToNull property to true.

You can hide a System.Web.UI.WebControls.BoundField object in a data-bound control by setting the DataControlField.Visible property 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.BoundField object by setting the DataControlField.InsertVisible property to false. This is commonly done when you want to hide an automatically generated key field in insert mode.

You can customize the header and footer sections of a System.Web.UI.WebControls.BoundField 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.BoundField object by setting the DataControlField.ShowHeader property to false.

Note:

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

DataControlField.FooterStyle

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

DataControlField.HeaderStyle

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

DataControlField.ItemStyle

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

Requirements

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