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 製品サンプル: データベースを参照してください。 実行しているSQL Serverのバージョンに合った正しいバージョンのサンプル データベースがインストールされていることを確認します。
• データ ドリブン Web サイト。 これにより、カスタマイズするデータ フィールドを含むデータベースとクラスのデータ コンテキストを作成できます。 詳細については、Walkthrough: Creating a New Dynamic Data Web Site using Scaffoldingを参照してください。

注釈

この属性をデータ フィールドに適用する場合は、属性の使用に関するガイドラインに従う必要があります。