BoundField.FormatDataValue(Object, Boolean) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

protected:
 virtual System::String ^ FormatDataValue(System::Object ^ dataValue, bool encode);

protected virtual string FormatDataValue (object dataValue, bool encode);

abstract member FormatDataValue : obj * bool -> string
override this.FormatDataValue : obj * bool -> string

Protected Overridable Function FormatDataValue (dataValue As Object, encode As Boolean) As String

Parameters

dataValue: Object

The field value to format.

encode: Boolean

true to encode the value; otherwise, false.

Returns

String

The field value converted to the format specified by DataFormatString.

Remarks

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.

Note

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.

Applies to

Compartilhar via