BoundField.DataFormatString プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

フィールドの値の表示形式を指定する文字列を取得または設定します。

public:
 virtual property System::String ^ DataFormatString { System::String ^ get(); void set(System::String ^ value); };
public virtual string DataFormatString { get; set; }
member this.DataFormatString : string with get, set
Public Overridable Property DataFormatString As String

プロパティ値

String

フィールドの値の表示形式を指定する書式指定文字列。 既定値は空の文字列 ("") です。この値は、フィールド値に適用される特定の書式が設定されていないことを示します。

例

ソース コードを含む Visual Studio Web サイト プロジェクトは、「 ダウンロード」のトピックに付属しています。

次の例は、 プロパティを使用して、フィールドの DataFormatString 値のカスタム表示形式を指定する方法を示しています。

次の例は、この例で生成される出力の 1 行を示しています。

ProductID 名前 ProductNumber ListPrice Weight ModifiedDate
000680 HL Road Frame - Black, 58 #FR-R92B-58 $1,431.50 1016.040 3/11/2004

注釈

オブジェクトに DataFormatString 表示される値のカスタム表示形式を指定するには、 プロパティを BoundField 使用します。 プロパティが DataFormatString 設定されていない場合、フィールドの値は特別な書式なしで表示されます。

注意

3.5 より前のバージョンの ASP.NET では、文字列データ型ではないフィールドを書式設定するには、 プロパティを にfalse設定HtmlEncodeする必要があります。 それ以外の場合、プロパティに格納されている書式指定文字列が適用される前に、既定の変換メソッドによってフィールド値が文字列に DataFormatString 変換されます。

既定では、書式設定文字列は、オブジェクトを含む BoundField データ バインド コントロールが読み取り専用モードの場合にのみフィールド値に適用されます。 編集モードでフィールド値に書式設定文字列を適用するには、 プロパティを ApplyFormatInEditMode に true設定します。

書式設定文字列には任意のリテラル文字列を指定でき、通常はフィールドの値のプレースホルダーが含まれます。 たとえば、書式設定文字列 では、文字列Item Value: {0}が オブジェクトに表示されるときに、フィールドの値がプレースホルダーにBoundField置き換えられます{0}。 書式設定文字列の残りの部分は、リテラル テキストとして表示されます。

書式設定文字列にプレースホルダーが含まれていない場合は、書式設定文字列自体のみが最終的な表示テキストに含まれます (データ ソースのフィールドの値は含まれません)。 前の例に示すように、プレースホルダーが中かっこで囲まれた 0 (ゼロ) の場合、フィールド値は既定のメソッドによって文字列に変換されます。 フィールド値の書式設定方法を指定する文字列を 0 に追加できます。 たとえば、数値フィールドのプレースホルダー {0:C} は、フィールドの値を通貨形式に変換することを指定します。

書式設定は、 メソッドを使用して適用されます Format 。 左中かっこの後に続く数値は、そのメソッドで使用される構文の一部であり、プレースホルダーで使用する一連の値の 1 つを示します。 各セルにはフィールド値が 1 つしかないため、左中かっこの後の数値は 0 にのみ設定できます。

次の表に、数値フィールドの標準書式文字を示します。 これらの書式文字では、 を除き X、大文字と小文字は区別されません。指定された場合は 16 進文字が表示されます。 表示する有効桁数または小数点以下桁数を指定するために、ほとんどの書式文字に数値を追加できます。

注意

ほとんどの場合、書式設定はサーバーのカルチャ設定によって異なります。 例は、 のカルチャ設定です en-US。

文字の書式設定 説明 例
C または c 数値を通貨形式で表示します。 小数点以下の桁数を指定できます。 形式: {0:C}

123.456 -> $123.46

形式: {0:C3}

123.456 -> $123.456
D または d 整数値を 10 進形式で表示します。 桁数を指定できます。 (型は "decimal" と呼ばれますが、数値は整数として書式設定されます)。 形式: {0:D}

1234 -> 1234

形式: {0:D6}

1234 -> 001234
E または e 数値を指数 (指数) 形式で表示します。 小数点以下の桁数を指定できます。 形式: {0:E}

1052.0329112756 -> 1.052033E+003

形式: {0:E2}

-1052.0329112756 -> -1.05e+003
F または f 数値を固定形式で表示します。 小数点以下の桁数を指定できます。 形式: {0:F}

1234.567 -> 1234.57

形式: {0:F3}

1234.567 -> 1234.567
G または g 数値を一般的な形式で表示します (固定小数点表記または指数表記の中で最もコンパクト)。 有効桁数を指定できます。 形式: {0:G}

-123.456 -> -123.456

形式: {0:G2}

-123.456 -> -120
N または n 数値を数値形式で表示します (グループ区切り記号と省略可能な負符号を含む)。 小数点以下の桁数を指定できます。 形式: {0:N}

1234.567 -> 1,234.57

形式: {0:N4}

1234.567 -> 1,234.5670
P または p パーセント形式で数値を表示します。 小数点以下の桁数を指定できます。 形式: {0:P}

1 -> 100.00%

形式: {0:P1}

.5 -> 50.0%
R または r SingleDouble、、または BigInteger の値をラウンドトリップ形式で表示します。 形式: {0:R}

123456789.12345678 -> 123456789.12345678
X または x 整数値を 16 進数形式で表示します。 桁数を指定できます。 形式: {0:X}

255 -> FF

形式: {0:x4}

255 -> 00ff

詳細および他のカルチャ値の書式設定を示す例については、「 標準の数値書式指定文字列」を参照してください。 カスタム数値書式指定文字列を作成することもできます。 詳細については、「カスタム数値形式文字列」をご覧ください。

次の表に、フィールドの書式文字を DateTime 示します。 これらの書式設定の仕様のほとんどは、カルチャ設定に応じて異なる出力になります。 例は、 DateTime カルチャ設定が の 2009 年 6 月 15 日午後 1:45:30 の en-US値です。

文字の書式設定 説明 例
d 短い形式の日付パターン。 形式: {0:d}

2009 年 6 月 15 日午後 1:45:30 -> 2009 年 6 月 15 日
D 長い形式の日付パターン。 形式: {0:D}

2009 年 6 月 15 日午後 1:45:30 ->2009 年 6 月 15 日月曜日
f 完全な日付と時刻のパターン (短い形式の時刻)。 形式: {0:f}

2009/6/15 1:45:30 PM -> 2009 年 6 月 15 日 (月) 午後 1:45
F 完全な日付と時刻のパターン (長い形式の時刻)。 形式: {0:F}

2009/6/15 1:45:30 PM -> 2009 年 6 月 15 日月曜日 1:45:30 PM
g 一般の日付と時刻のパターン (短い形式の時刻)。 形式: {0:g}

2009/6/15 1:45:30 PM -> 6/15/2009 1:45 PM
G 一般の日付と時刻のパターン (長い形式の時刻)。 形式: {0:G}

2009/6/15 1:45:30 PM -> 6/15/2009 1:45:30 PM
M または m 月日パターン。 形式: {0:M}

2009 年 6 月 15 日午後 1:45:30 -> 6 月 15 日
O または o ラウンドトリップする日付と時刻のパターン。 形式: {0:o}

2009/6/15 1:45:30 PM -> 2009-06-15T13:45:30.0900000
R または r RFC1123 パターン (詳細については、「」を参照してください DateTimeFormatInfo.RFC1123Pattern)。 形式: {0:R}

2009 年 6 月 15 日 1:45:30 -> 2009 年 6 月 15 日 (月) 20:45:30 GMT
s 並べ替え可能な日付と時刻のパターン。 形式: {0:s}

2009/6/15 1:45:30 PM -> 2009-06-15T13:45:30
t 短い形式の時刻パターン。 形式: {0:t}

2009 年 6 月 15 日午後 1:45:30 -> 午後 1:45
T 長い形式の時刻パターン。 形式: {0:T}

2009/6/15 1:45:30 PM -> 1:45:30 PM
u 並べ替え可能な日付と時刻のパターン (世界時刻)。 形式: {0:u}

2009/6/15 1:45:30 PM -> 2009-06-15 20:45:30Z
U 完全な日付と時刻のパターン (世界時刻)。 形式: {0:U}

2009/6/15 1:45:30 PM -> 2009 年 6 月 15 日月曜日 8:45:30 PM
Y または y 年月パターン。 形式: {0:Y}

2009 年 6 月 15 日午後 1:45:30 -> 2009 年 6 月

詳細および他のカルチャ値の書式設定を示す例については、「 標準の日付と時刻の書式指定文字列」を参照してください。 カスタムの日付と時刻の書式指定文字列を作成することもできます。 詳細については、「 カスタム日付と時刻の書式指定文字列」を参照してください。

適用対象

こちらもご覧ください