DisplayFormatAttribute Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Указывает, как отображаются и форматируются поля данных ASP.NET динамических данных.
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
- Наследование
- Атрибуты
Примеры
В следующем примере показано, как настроить DisplayFormatAttribute форматирование для поля данных. В примере выполняются следующие действия.
Реализует частичный класс метаданных и связанный класс метаданных.
В связанном классе метаданных атрибут применяется DisplayFormatAttribute для указания следующих результатов:
- Отображение текста "[NULL]" при пустом поле данных.
- Отображение данных валюты в определенном формате валюты языкового стандарта.
- Отображение сведений о дате в коротком формате (мм/дд/гг). Этот формат также применяется в режиме редактирования.
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, см. в разделе Microsoft SQL Server Примеры продуктов: База данных на GitHub. Убедитесь, что установлена правильная версия образца базы данных для версии SQL Server, которую вы используете.
- Веб-сайт на основе данных. Это позволяет создать контекст данных для базы данных и класса, содержащего поле данных для настройки. Дополнительные сведения см. в разделе
Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.
Комментарии
При применении этого атрибута к полю данных необходимо следовать рекомендациям по использованию атрибутов.
Конструкторы
| Имя | Описание |
|---|---|
| DisplayFormatAttribute() |
Инициализирует новый экземпляр класса DisplayFormatAttribute. |
Свойства
| Имя | Описание |
|---|---|
| ApplyFormatInEditMode |
Возвращает или задает значение, указывающее, применяется ли строка форматирования, указанная DataFormatString свойством, к значению поля, когда поле данных находится в режиме редактирования. |
| ConvertEmptyStringToNull |
Возвращает или задает значение, указывающее, будут ли пустые строковые значения ("") автоматически преобразовываться |
| DataFormatString |
Возвращает или задает формат отображения для значения поля. |
| HtmlEncode |
Возвращает или задает значение, указывающее, должно ли поле быть закодировано HTML. |
| NullDisplayText |
Возвращает или задает текст, отображаемый для поля при значении |
| NullDisplayTextResourceType |
Возвращает или задает Type объект, содержащий ресурсы для NullDisplayText. Использование NullDisplayTextResourceType вместе с NullDisplayTextним позволяет GetNullDisplayText() методу возвращать локализованные значения. |
| TypeId |
При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute) |
Методы
| Имя | Описание |
|---|---|
| Equals(Object) |
Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute) |
| GetHashCode() |
Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute) |
| GetNullDisplayText() |
Возвращает строку отображения пользовательского интерфейса для NullDisplayText. |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| IsDefaultAttribute() |
При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute) |
| Match(Object) |
При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Явные реализации интерфейса
| Имя | Описание |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute) |