DisplayFormatAttribute Класс

Определение

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

System.ComponentModel.DataAnnotations

Сборка:

System.ComponentModel.Annotations.dll

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

DisplayFormatAttribute.cs

Задает способ отображения и форматирования полей данных в платформе динамических данных 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

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

Object

Attribute

DisplayFormatAttribute

Атрибуты

AttributeUsageAttribute

Примеры

См. онлайн-пример этой функции: Выполнить.

В следующем примере показано, как использовать 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.

Комментарии

При применении этого атрибута к полю данных необходимо следовать рекомендациям по использованию атрибутов. Дополнительные сведения см . в ASP.NET рекомендации по динамическим данным.

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

DisplayFormatAttribute()

Инициализирует новый экземпляр класса DisplayFormatAttribute.

Свойства

ApplyFormatInEditMode	Возвращает или задает значение, указывающее, применимо ли свойство DataFormatString к значению поля, если поле данных находится в режиме редактирования.
ConvertEmptyStringToNull	Возвращает или задает значение, показывающее, выполняется ли автоматическое преобразование пустых строковых значений ("")в значения null при обновлении поля данных в источнике данных.
DataFormatString	Возвращает или задает формат отображения значения поля.
HtmlEncode	Получает или задает значение, указывающее, должно ли поле кодироваться в формате HTML.
NullDisplayText	Возвращает или задает текст, отображаемый в поле, значение которого равно null.
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)

См. также раздел

• Практическое руководство. Указание значений языка и региональных параметров (пользовательского интерфейса) для глобализации веб-страниц ASP.NET