This documentation is archived and is not being maintained.

BoundField.FormatDataValue Method

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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