DisplayFormatAttribute クラス

定義

ASP.NET Dynamic Data によるデータ フィールドの表示方法と書式を指定します。Specifies how data fields are displayed and formatted by ASP.NET Dynamic Data.

public ref class DisplayFormatAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
[System.AttributeUsage]
public class DisplayFormatAttribute : Attribute
type DisplayFormatAttribute = class
    inherit Attribute
Public Class DisplayFormatAttribute
Inherits Attribute
継承
DisplayFormatAttribute
属性

この機能のオンラインの例については、「 Run」を参照してください。See an online example of this feature: Run.

次の例では、DisplayFormatAttribute を使用して、データフィールドの書式をカスタマイズする方法を示します。The following example shows how to use the DisplayFormatAttribute to customize formatting for a data field. この例では、次の手順を実行します。The example performs the following steps:

  • メタデータ部分クラスと関連付けられたメタデータクラスを実装します。Implements a metadata partial class and an associated metadata class.

  • 関連付けられたメタデータクラスでは、DisplayFormatAttribute 属性を適用して、次の結果を指定します。In the associated metadata class, it applies the DisplayFormatAttribute attribute to specify the following results:

    • データフィールドが空の場合は、"[Null]" というテキストを表示します。Display the text "[Null]" when a data field is empty.

    • 通貨データをロケール固有の通貨形式で表示します。Display currency data in locale specific currency format.

    • 日付情報を短い形式 (mm/dd/yy) で表示します。Display date information in short format (mm/dd/yy). この形式は編集モードでも適用されます。This format also applies in edit mode.

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

この例をコンパイルするには、次のものが必要です。To compile the example, you need the following:

  • Visual Studio 2010 以降の任意のエディション。Any edition of Visual Studio 2010 or later.

  • AdventureWorksLT サンプルデータベース。The AdventureWorksLT sample database. SQL Server サンプルデータベースをダウンロードしてインストールする方法の詳細については、GitHub の「製品サンプル: データベース」を参照し Microsoft SQL Server てください。For information about how to download and install the SQL Server sample database, see Microsoft SQL Server Product Samples: Database on GitHub. 実行している SQL Server のバージョンに適したバージョンのサンプルデータベースがインストールされていることを確認してください。Make sure that you install the correct version of the sample database for the version of SQL Server that you are running.

  • データドリブンの Web サイト。A data-driven Web site. これにより、データベースのデータコンテキストと、カスタマイズするデータフィールドを含むクラスを作成できます。This enables you to create a data context for the database and the class that contains the data field to customize. 詳細については、「 Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding」を参照してください。For more information, see Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

注釈

この属性をデータフィールドに適用する場合は、属性を使用するためのガイドラインに従う必要があります。When you apply this attribute to a data field, you must follow the guidelines for the use of the attributes. 詳細については、「 ASP.NET 動的データのガイドライン」を参照してください。For more information, see ASP.NET Dynamic Data Guidelines.

コンストラクター

DisplayFormatAttribute()

DisplayFormatAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DisplayFormatAttribute class.

プロパティ

ApplyFormatInEditMode

データ フィールドが編集モードである場合に DataFormatString プロパティで指定した書式指定文字列をフィールド値に適用するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the formatting string that is specified by the DataFormatString property is applied to the field value when the data field is in edit mode.

ConvertEmptyStringToNull

データ ソースのデータ フィールドを更新するときに、空の文字列値 ("") を null に自動的に変換するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether empty string values ("") are automatically converted to null when the data field is updated in the data source.

DataFormatString

フィールド値の表示形式を取得または設定します。Gets or sets the display format for the field value.

HtmlEncode

フィールドを HTML エンコードするかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the field should be HTML-encoded.

NullDisplayText

フィールドの値が null の場合にフィールドに表示するテキストを取得または設定します。Gets or sets the text that is displayed for a field when the field's value is null.

NullDisplayTextResourceType

Type のリソースを含む NullDisplayText を取得または設定します。Gets or sets the Type that contains the resources for NullDisplayText.

NullDisplayTextResourceTypeNullDisplayText を使用して、GetNullDisplayText() メソッドでローカライズされた値を返すことを許可します。Using NullDisplayTextResourceType along with NullDisplayText, allows the GetNullDisplayText() method to return localized values.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetNullDisplayText()

NullDisplayText に対する UI 表示文字列を返します。Returns the UI display string for NullDisplayText.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください