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
)

Parameters

dataValue
Type: System::Object

The field value to format.

encode
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.

NoteNote:

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: