DisplayFormatAttribute Класс

Определение

Задает способ отображения и форматирования полей данных в платформе динамических данных ASP.NET.Specifies how data fields are displayed and formatted by ASP.NET Dynamic Data.

public ref class DisplayFormatAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
[System.AttributeUsage]
public class DisplayFormatAttribute : Attribute
type DisplayFormatAttribute = class
    inherit Attribute
Public Class DisplayFormatAttribute
Inherits Attribute
Наследование
DisplayFormatAttribute
Атрибуты

Примеры

См. Интерактивный пример этой функции: Run.See an online example of this feature: Run.

В следующем примере показано, как использовать DisplayFormatAttribute для настройки форматирования поля данных.The following example shows how to use the DisplayFormatAttribute to customize formatting for a data field. В этом примере выполняются следующие действия.The example performs the following steps:

  • Реализует разделяемый класс метаданных и связанный класс метаданных.Implements a metadata partial class and an associated metadata class.

  • В связанном классе метаданных он применяет атрибут DisplayFormatAttribute, чтобы указать следующие результаты.In the associated metadata class, it applies the DisplayFormatAttribute attribute to specify the following results:

    • Отображать текст "[NULL]", если поле данных пусто.Display the text "[Null]" when a data field is empty.

    • Отображение денежных данных в формате валюты для определенной национальной настройки.Display currency data in locale specific currency format.

    • Отображение сведений о дате в кратком формате (мм/дд/гг).Display date information in short format (mm/dd/yy). Этот формат также применяется в режиме редактирования.This format also applies in edit mode.

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

Чтобы скомпилировать пример, вам потребуется следующее: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, см. в разделе Microsoft SQL Server Samples: Database на сайте GitHub.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.

  • Управляемый данными веб-сайт.A data-driven Web site. Это позволяет создать контекст данных для базы данных и класс, содержащий настраиваемое поле данных.This enables you to create a data context for the database and 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 you apply this attribute to a data field, you must follow the guidelines for the use of the attributes. Дополнительные сведения см. в разделе ASP.NET платформа динамических данных рекомендации.For more information, see ASP.NET Dynamic Data Guidelines.

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

DisplayFormatAttribute()

Инициализирует новый экземпляр класса DisplayFormatAttribute.Initializes a new instance of the DisplayFormatAttribute class.

Свойства

ApplyFormatInEditMode

Возвращает или задает значение, указывающее, применимо ли свойство DataFormatString к значению поля, если поле данных находится в режиме редактирования.Gets or sets a value that indicates whether the formatting string that is specified by the DataFormatString property is applied to the field value when the data field is in edit mode.

ConvertEmptyStringToNull

Возвращает или задает значение, показывающее, выполняется ли автоматическое преобразование пустых строковых значений ("")в значения null при обновлении поля данных в источнике данных.Gets or sets a value that indicates whether empty string values ("") are automatically converted to null when the data field is updated in the data source.

DataFormatString

Возвращает или задает формат отображения значения поля.Gets or sets the display format for the field value.

HtmlEncode

Получает или задает значение, указывающее, должно ли поле кодироваться в формате HTML.Gets or sets a value that indicates whether the field should be HTML-encoded.

NullDisplayText

Возвращает или задает текст, отображаемый в поле, значение которого равно null.Gets or sets the text that is displayed for a field when the field's value is null.

NullDisplayTextResourceType

Возвращает или задает тип Type, который содержит ресурсы для NullDisplayText.Gets or sets the Type that contains the resources for NullDisplayText.

Использование свойства NullDisplayTextResourceType вместе со свойством NullDisplayText позволяет методу GetNullDisplayText() возвращать локализованные значения.Using NullDisplayTextResourceType along with NullDisplayText, allows the GetNullDisplayText() method to return localized values.

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

Возвращает отображаемую в пользовательском интерфейсе строку для NullDisplayText.Returns the UI display string for NullDisplayText.

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

Возвращает строку, представляющую текущий объект.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)

Применяется к

Дополнительно