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 метаданных, чтобы указать следующее:

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

  • Столбец "Почтовый код" из таблицы "Адрес" (родительская таблица) используется для сортировки поля выбора адреса в дочерней таблице 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.

Комментарии

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

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

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

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

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

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

Имя	Описание
DisplayColumnAttribute(String, String, Boolean)	Инициализирует новый экземпляр класса с помощью указанного DisplayColumnAttribute отображаемого столбца, а также указанного столбца сортировки и порядка сортировки.
DisplayColumnAttribute(String, String)	Инициализирует новый экземпляр класса с помощью указанных DisplayColumnAttribute столбцов отображения и сортировки.
DisplayColumnAttribute(String)	Инициализирует новый экземпляр класса с помощью указанного 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)