DisplayFormatAttribute 类

定义

public ref class DisplayFormatAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public class DisplayFormatAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type DisplayFormatAttribute = class
    inherit Attribute

Public Class DisplayFormatAttribute
Inherits Attribute

继承

Object

Attribute

DisplayFormatAttribute

属性

AttributeUsageAttribute

示例

以下示例演示如何使用 DisplayFormatAttribute 数据字段自定义格式设置。 此示例执行以下步骤：

• 实现元数据分部类和关联的元数据类。

• 在关联的元数据类中 DisplayFormatAttribute ，它应用属性来指定以下结果：

  • 当数据字段为空时，显示文本“[Null]”。
  • 以区域设置特定的货币格式显示货币数据。
  • 以短格式显示日期信息（mm/dd/yy）。 此格式也适用于编辑模式。

using System;
using System.Web.DynamicData;
using System.ComponentModel.DataAnnotations;

[MetadataType(typeof(ProductMetaData))]
public partial class Product
{
}

public class ProductMetaData
{
    
    // Applying DisplayFormatAttribute
    // Display the text [Null] when the data field is empty.
    // Also, convert empty string to null for storing.
    [DisplayFormat(ConvertEmptyStringToNull = true, NullDisplayText = "[Null]")]
    public object Size;

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

    // 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;
}

Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations


<MetadataType(GetType(ProductMetaData))> _
Partial Public Class Product

End Class

Public Class ProductMetaData
   
    ' Applying DisplayFormatAttribute

    ' Display the text [Null] when the data field is empty.
    ' Also, convert empty string to null for storing.
    <DisplayFormat(ConvertEmptyStringToNull:=True, NullDisplayText:="[Null]")> _
    Public Size As Object

    ' 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 such as 11/12/08.
    ' Also, apply format in edit mode.
    <DisplayFormat(ApplyFormatInEditMode:=True, DataFormatString:="{0:d}")> _
    Public SellStartDate As Object

End Class

若要编译示例，需要满足以下条件：

• Visual Studio 2010 或更高版本的任何版本。
• AdventureWorksLT 示例数据库。 有关如何下载和安装SQL Server示例数据库的信息，请参阅 GitHub 上的 Microsoft SQL Server Product Samples： Database。 请确保为正在运行的 SQL Server 版本安装示例数据库的正确版本。
• 数据驱动的网站。 这样，便可以为数据库和包含要自定义的数据字段的类创建数据上下文。 有关详细信息，请参阅 Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding。

注解

将此属性应用于数据字段时，必须遵循属性的使用准则。