System.Web.UI.WebControls Namespace

---

.NET Framework version 2.0

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

BoundField Class Members

Show Inherited Members

Constructors Visibility Constructor Parameters public BoundField ( )   Fields Visibility Name Type public static ThisExpression String   Properties Visibility Name Value Type Accessibility public ApplyFormatInEditMode Boolean [ Get , Set ] public ConvertEmptyStringToNull Boolean [ Get , Set ] public DataField String [ Get , Set ] public DataFormatString String [ Get , Set ] public HeaderText String [ Get , Set ] public HtmlEncode Boolean [ Get , Set ] public HtmlEncodeFormatString Boolean [ Get , Set ] public NullDisplayText String [ Get , Set ] public ReadOnly Boolean [ Get , Set ] public ValidateRequestMode ValidateRequestMode [ Get , Set ]   Methods Visibility Name Parameters Return Type protected CopyProperties ( DataControlField newField ) Void protected CreateField ( ) DataControlField public ExtractValuesFromCell ( IOrderedDictionary dictionary , DataControlFieldCell cell , DataControlRowState rowState , Boolean includeReadOnly ) Void protected FormatDataValue ( Object dataValue , Boolean encode ) String protected GetDesignTimeValue ( ) Object protected GetValue ( Control controlContainer ) Object public Initialize ( Boolean enableSorting , Control control ) Boolean public InitializeCell ( DataControlFieldCell cell , DataControlCellType cellType , DataControlRowState rowState , Int32 rowIndex ) Void protected InitializeDataCell ( DataControlFieldCell cell , DataControlRowState rowState ) Void protected LoadViewState ( Object state ) Void protected OnDataBindField ( Object sender , EventArgs e ) Void public ValidateSupportsCallback ( ) Void

The BoundField class is used by data-bound controls ( such as GridView and DetailsView ) to display the value of a field as text. The BoundField object is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays a BoundField object as a column, while the DetailsView control displays it as a row.

To specify the field to display in a BoundField object, set the DataField property to the field's name. The field's value can be HTML-encoded before it is displayed by setting the HtmlEncode property to true. You can apply a custom formatting string to the field's value by setting the DataFormatString property.

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 ApplyFormatInEditMode property to true.

If a field's value is null, you can display a custom caption by setting the NullDisplayText property. The BoundField object can also automatically convert empty string ( "" ) field values to null values by setting the ConvertEmptyStringToNull property to true.

You can hide a BoundField object in a data-bound control by setting the Visible property 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 BoundField object by setting the 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 BoundField 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 BoundField object by setting the ShowHeader property to false.

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

Style property	Description
ControlStyle	The style settings for the child Web server controls of the BoundField object.
FooterStyle	The style settings for the footer section of the BoundField object.
HeaderStyle	The style settings for the header section of the BoundField object.
ItemStyle	The style settings for the data items in the BoundField object.

The following examples demonstrate using a BoundField object in different scenarios.

GridView BoundField Example Run Sample | View Source

DetailsView PagerSettings, PagerStyle Example Run Sample | View Source

FormView with Nested GridView Run Sample | View Source

ButtonField   CheckBoxField   CommandField   HyperLinkField   ImageField   TemplateField

Suggested Reading