DisplayFormatAttribute.DataFormatString プロパティ

定義

名前空間:

System.ComponentModel.DataAnnotations

アセンブリ:

System.ComponentModel.Annotations.dll

ソース:

DisplayFormatAttribute.cs

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

public:
 property System::String ^ DataFormatString { System::String ^ get(); void set(System::String ^ value); };

public string? DataFormatString { get; set; }

member this.DataFormatString : string with get, set

Public Property DataFormatString As String

プロパティ値

String

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

例

次の例では、 DataFormatString プロパティを使用してデータ フィールドの表示形式を設定する方法を示します。 最初の例では、通貨型データ フィールドの表示形式を設定します。 2 番目の例では、日付型のデータ フィールドの表示形式を設定します。

// Display currency data field in the format $1,345.50.
[DisplayFormat(DataFormatString="{0:C}")]
public object StandardCost;

' Display currency data field in the format such as $1,345.50.
<DisplayFormat(DataFormatString:="{0:C}")> _
Public StandardCost As Object

// Display date data field in the short format 11/12/08.
// Also, apply format in edit mode.
[DisplayFormat(ApplyFormatInEditMode=true, DataFormatString = "{0:d}")]
public object SellStartDate;

' Display date data field in the short format such as 11/12/08.
' Also, apply format in edit mode.
<DisplayFormat(ApplyFormatInEditMode:=True, DataFormatString:="{0:d}")> _
Public SellStartDate As Object

注釈

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

注

DynamicField.HtmlEncode プロパティがtrueされると、書式設定文字列が適用される前に、フィールドの値が文字列形式に HTML エンコードされます。 日付などの一部のオブジェクトでは、書式設定文字列を使用してオブジェクトを表示する方法を制御できます。 このような場合は、 DynamicField.HtmlEncode プロパティを false に設定する必要があります。

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

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

注

書式設定文字列にプレースホルダーが含まれていない場合、データ ソースのフィールドの値は最終的な表示テキストに含まれません。

こちらもご覧ください

• .NET での型の書式設定