BoundField.FormatDataValue Method

Note: This method is new in the .NET Framework version 2.0.

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
)
protected String FormatDataValue (
	Object dataValue, 
	boolean encode
)
protected function FormatDataValue (
	dataValue : Object, 
	encode : boolean
) : String

Parameters

dataValue

The field value to format.

encode

true to encode the value; otherwise, false.

Return Value

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 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: