DisplayColumnAttribute Класс

Определение

Пространство имен:

System.ComponentModel.DataAnnotations

Сборка:

System.ComponentModel.Annotations.dll

Исходный код:

DisplayColumnAttribute.cs

Указывает столбец, который отображается в связанной таблице как столбец внешнего ключа.

public ref class DisplayColumnAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public class DisplayColumnAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)>]
type DisplayColumnAttribute = class
    inherit Attribute

Public Class DisplayColumnAttribute
Inherits Attribute

Наследование

Object

Attribute

DisplayColumnAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере показано использование атрибута DisplayColumnAttribute. В этом примере выполняются следующие задачи:

• Реализует разделяемые классы метаданных для таблиц Address и Customer, которые являются родительскими таблицами для таблицы CustomerAddress.

• Применяет DisplayColumnAttribute атрибут к разделяемым Address классам метаданных, чтобы указать следующее:

  • Столбец City из таблицы Address (родительской таблицы) отображается как столбец внешнего ключа в дочерней таблице CustomerAddress.

  • Столбец PostalCode из таблицы Address (родительской таблицы) используется для сортировки поля выбора адреса в дочерней таблице CustomerAddress.

  • Для порядка сортировки задано значение по возрастанию.

В примере атрибут применяется DisplayColumnAttribute к разделяемым Customer классу метаданных, чтобы указать, что столбец LastName в отображается в качестве столбца внешнего ключа для таблицы CustomerAddress.

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

Чтобы скомпилировать пример, вам потребуется следующее:

• Любой выпуск Visual Studio 2010 или более поздней версии.

• Пример базы данных AdventureWorksLT. Сведения о том, как скачать и установить образец базы данных SQL Server, см. в разделе Примеры продуктов Microsoft SQL Server: База данных на GitHub. Убедитесь, что установлена правильная версия образца базы данных для версии SQL Server, которую вы используете.

• Динамический веб-сайт, управляемый данными. Это позволяет создать контекст данных для базы данных и класс, содержащий настраиваемое поле данных. Для получения дополнительной информации см. Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Комментарии

Если столбец в таблице содержит внешний ключ, динамические данные выводят отображаемое значение для этого столбца из указанной таблицы. По умолчанию используется первый столбец таблицы, на которую указывает ссылка, типом которого является string (или text). Атрибут DisplayColumnAttribute позволяет изменить это поведение по умолчанию и указать другой столбец родительской таблицы, который будет использоваться в качестве столбца для поля внешнего ключа.

При применении этого атрибута необходимо соблюдать следующие ограничения использования:

• Атрибут может применяться только к классу.

• Атрибут может наследоваться производными классами.

• Атрибут можно применить только один раз.

Конструкторы

DisplayColumnAttribute(String)	Инициализирует новый экземпляр DisplayColumnAttribute, используя заданный столбец.
DisplayColumnAttribute(String, String)	Инициализирует новый экземпляр DisplayColumnAttribute, используя заданный отображаемый столбец и столбец сортировки.
DisplayColumnAttribute(String, String, Boolean)	Инициализирует новый экземпляр DisplayColumnAttribute, используя указанный отображаемый столбец, а также заданный столбец для сортировки и порядок сортировки.

Свойства

DisplayColumn	Получает имя столбца, который следует использовать в качестве отображаемого поля.
SortColumn	Получает имя столбца, который следует использовать для сортировки.
SortDescending	Получает значение, указывающее, в каком порядке выполняется сортировка: в порядке возрастания или в порядке убывания.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)