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 屬性來設定數據欄位的顯示格式。 第一個範例會設定貨幣類型數據欄位的顯示格式。 第二個範例會設定日期類型數據欄位的顯示格式。

// 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時，欄位的值會先編碼成其字串表示，再套用格式化字串。 對於某些物件，例如日期，您可能會想要控制物件如何以格式字串顯示物件。 在這些情況下，您必須將 DynamicField.HtmlEncode 屬性設定為 false。

根據預設，只有在包含 DynamicField 對象的數據綁定控件處於只讀模式時，才會將格式化字串套用至域值。 若編輯模式中將格式化字串套用至網域值，請將 ApplyFormatInEditMode 屬性設定為 true。

格式字串可以是任何常值字串，通常包含字段值的佔位元。 例如，在格式化字串 「Item Value： {0}」中，當字串顯示在物件中DynamicField時，字段的值會取代{0}佔位元。 格式化字串的其餘部分會顯示為常值文字。

注意

如果格式化字串不包含佔位元，則數據源中的欄位值不會包含在最終顯示文字中。

另請參閱

• 在 .NET 中將類型格式化