BoundField.FormatDataValue メソッド

.NET Framework クラス ライブラリ リファレンス

BoundField.FormatDataValue メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

BoundField オブジェクトのセルの指定したフィールド値を書式変換します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim dataValue As Object
Dim encode As Boolean
Dim returnValue As String

returnValue = Me.FormatDataValue(dataValue, encode)

C#

protected virtual string FormatDataValue (
    Object dataValue,
    bool encode
)

C++

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

J#

protected String FormatDataValue (
    Object dataValue, 
    boolean encode
)

JScript

protected function FormatDataValue (
    dataValue : Object, 
    encode : boolean
) : String

パラメータ

dataValue

書式を変換するフィールド値。

encode

値をエンコードする場合は true。それ以外の場合は false。

戻り値
DataFormatString で指定した書式に変換するフィールド値。

解説

FormatDataValue メソッドは、DataFormatString プロパティで指定した書式にフィールド値を変換するために使用されるヘルパー メソッドです。フィールド値が null の場合、NullDisplayText プロパティの値が返されます。

メモ
このメソッドは、主にコントロールの開発者によって使用されます。

継承時の注意 BoundField クラスを拡張すると、このメソッドをオーバーライドしてカスタムの書式指定ルーチンを実行できます。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
BoundField クラス
BoundField メンバ
System.Web.UI.WebControls 名前空間