BoundField.FormatDataValue Method (Object, Boolean)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Formats the specified field value for a cell in the BoundField object.

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

protected virtual string FormatDataValue(
	object dataValue,
	bool encode


Type: System.Object

The field value to format.

Type: System.Boolean

true to encode the value; otherwise, false.

Return Value

Type: System.String

The field value converted to the format specified by DataFormatString.

The FormatDataValue method is a helper method used to transform a field value to the format specified by the DataFormatString property. If a field value is null, the value of the NullDisplayText property is returned.


This method is used primarily by control developers.

Notes to Inheritors:

When extending the BoundField class, you can override this method to perform a custom formatting routine.

.NET Framework
Available since 2.0
Return to top