DisplayFormatAttribute.DataFormatString 属性

定义

命名空间:

System.ComponentModel.DataAnnotations

程序集:

System.ComponentModel.Annotations.dll

Source:

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时，在应用格式字符串之前，字段的值将 HTML 编码为其字符串表示形式。 对于某些对象（如日期），你可能希望使用格式字符串控制对象的显示方式。 在这些情况下，必须将 属性设置为 DynamicField.HtmlEncodefalse。

默认情况下，仅当包含 DynamicField 对象的数据绑定控件处于只读模式时，格式设置字符串才应用于字段值。 若要在字段值处于编辑模式时将格式字符串应用于字段值，请将 ApplyFormatInEditMode 属性设置为 true。

格式字符串可以是任何文本字符串，通常包括字段值的占位符。 例如，在格式字符串“Item Value： {0}”中，当字符串显示在 对象中DynamicField时，字段的值将替换为{0}占位符。 格式字符串的其余部分显示为文本文本。

注意

如果格式设置字符串不包含占位符，则来自数据源的字段值不会包含在最终显示文本中。

另请参阅

• 设置 .NET 中类型的格式