DisplayColumnAttribute クラス

定義

参照先テーブルで外部キー列として表示される列を指定します。Specifies the column that is displayed in the referred table as a foreign-key column.

public ref class DisplayColumnAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
[System.AttributeUsage]
public class DisplayColumnAttribute : Attribute
type DisplayColumnAttribute = class
    inherit Attribute
Public Class DisplayColumnAttribute
Inherits Attribute
継承
DisplayColumnAttribute
属性

DisplayColumnAttribute 属性を使用する方法を次のコード例に示します。The following example shows how to use the DisplayColumnAttribute attribute. この例では、次のタスクを実行します。The example performs the following tasks:

  • Address テーブルと Customer テーブルのメタデータ部分クラスを実装します。これは、CustomerAddress テーブルの親テーブルです。Implements metadata partial classes for the Address and Customer tables, which are parent tables for the CustomerAddress table.

  • DisplayColumnAttribute 属性を Address metadata 部分クラスに適用して、次のように指定します。Applies the DisplayColumnAttribute attribute to the Address metadata partial class to specify the following:

    • Address テーブルの City 列 (親テーブル) は、CustomerAddress 子テーブルの外部キー列として表示されます。The City column from the Address table (the parent table) is displayed as the foreign-key column in the CustomerAddress child table.

    • Address テーブルの郵便番号列 (親テーブル) は、CustomerAddress 子テーブル内のアドレス選択ボックスの並べ替えに使用されます。The PostalCode column from the Address table (the parent table) is used for sorting the Address selection box in the CustomerAddress child table.

    • 並べ替え順序は昇順に設定されます。The sort order is set to ascending.

この例では、DisplayColumnAttribute 属性を Customer metadata 部分クラスに適用して、の LastName 列を CustomerAddress テーブルの外部キー列として表示するように指定しています。The example applies the DisplayColumnAttribute attribute to the Customer metadata partial class to specify that the LastName column in displayed as the foreign-key column for the CustomerAddress table.

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

[DisplayColumn("City", "PostalCode", false)]
public partial class Address
{
   
}

[DisplayColumn("LastName")]
public partial class Customer
{

}


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

<DisplayColumn("City", "PostalCode", False)> _
Partial Public Class Address

End Class

<DisplayColumn("LastName")> _
Public Partial Class Customer

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 dynamic data-driven Web site. これにより、データベースのデータコンテキストを作成し、カスタマイズするデータフィールドを含むクラスを作成することができます。This enables you to create a data context for the database and to create 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 a column in a table contains a foreign key, Dynamic Data infers the display value for that column from the referenced table. 既定では、型が string (または text) である参照先テーブルの最初の列が使用されます。By default, the first column of the referenced table whose type is string (or text) is used. DisplayColumnAttribute 属性を使用すると、この既定の動作を変更したり、外部キーフィールドの列として使用する別の親テーブル列を指定したりすることができます。The DisplayColumnAttribute attribute enables you to change this default behavior and to specify a different parent table column to use as the column for the foreign key field.

この属性を適用する場合は、次の使用制約に従う必要があります。When you apply this attribute, you must adhere to the following usage constraints:

  • 属性は、クラスにのみ適用できます。The attribute can only be applied to a class.

  • 属性は、派生クラスによって継承できます。The attribute can be inherited by derived classes.

  • 属性を適用できるのは1回だけです。The attribute can be applied only one time.

コンストラクター

DisplayColumnAttribute(String)

指定された列を使用して、DisplayColumnAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DisplayColumnAttribute class by using the specified column.

DisplayColumnAttribute(String, String)

指定された表示列と並べ替え列を使用して、DisplayColumnAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DisplayColumnAttribute class by using the specified display and sort columns.

DisplayColumnAttribute(String, String, Boolean)

指定された表示列と指定された並べ替え列および並べ替え順序を使用して、DisplayColumnAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DisplayColumnAttribute class by using the specified display column, and the specified sort column and sort order.

プロパティ

DisplayColumn

表示フィールドとして使用する列の名前を取得します。Gets the name of the column to use as the display field.

SortColumn

並べ替えに使用する列の名前を取得します。Gets the name of the column to use for sorting.

SortDescending

降順と昇順のどちらで並べ替えるかを示す値を取得します。Gets a value that indicates whether to sort in descending or ascending order.

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)
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)

適用対象