DisplayFormatAttribute Classe

Definição

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Origem:

DisplayFormatAttribute.cs

Especifica como os campos de dados são exibidos e formatados por Dados Dinâmicos do 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

Herança

Object

Attribute

DisplayFormatAttribute

Atributos

AttributeUsageAttribute

Exemplos

Veja um exemplo online desse recurso: Executar.

O exemplo a seguir mostra como usar o DisplayFormatAttribute para personalizar a formatação de um campo de dados. O exemplo executa as seguintes etapas:

• Implementa uma classe parcial de metadados e uma classe de metadados associada.

• Na classe de metadados associada, ela aplica o DisplayFormatAttribute atributo para especificar os seguintes resultados:

  • Exiba o texto "[Null]" quando um campo de dados estiver vazio.

  • Exibir dados de moeda no formato de moeda específico da localidade.

  • Exibir informações de data em formato curto (mm/dd/yy). Esse formato também se aplica no modo de edição.

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

Para compilar o exemplo, você precisa do seguinte:

• Qualquer edição do Visual Studio 2010 ou posterior.

• O banco de dados de exemplo AdventureWorksLT. Para obter informações sobre como baixar e instalar o banco de dados de exemplo do SQL Server, consulte Exemplos de produto do Microsoft SQL Server: Banco de dados no GitHub. Instale a versão correta do banco de dados de exemplo para a versão do SQL Server que você está executando.

• Um site controlado por dados. Isso permite que você crie um contexto de dados para o banco de dados e a classe que contém o campo de dados a ser personalizado. Para obter mais informações, consulte Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Comentários

Ao aplicar esse atributo a um campo de dados, você deve seguir as diretrizes para o uso dos atributos. Para obter mais informações, consulte ASP.NET Diretrizes de dados dinâmicos.

Construtores

DisplayFormatAttribute()

Inicializa uma nova instância da classe DisplayFormatAttribute.

Propriedades

ApplyFormatInEditMode	Obtém ou define um valor que indica se a cadeia de caracteres de formatação especificada pela propriedade DataFormatString é aplicada ao valor do campo quando o campo de dados está no modo de edição.
ConvertEmptyStringToNull	Obtém ou define um valor que indica se os valores de cadeia de caracteres vazia ("") são convertidos automaticamente em null quando o campo de dados é atualizado na fonte de dados.
DataFormatString	Obtém ou define o formato de exibição do valor do campo.
HtmlEncode	Obtém ou define um valor que indica se o campo deve ser codificado em HTML.
NullDisplayText	Obtém ou define o texto exibido em um campo quando o valor do campo é null.
NullDisplayTextResourceType	Obtém ou define o Type que contém os recursos para NullDisplayText. Usando o NullDisplayTextResourceType junto com NullDisplayText, permite que o método GetNullDisplayText() retorne valores localizados.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetNullDisplayText()	Retorna a cadeia de caracteres de exibição da interface do usuário para NullDisplayText.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• How to: Set the Culture and UI Culture for ASP.NET Web Page Globalization (Como definir a cultura e a cultura da interface do usuário para globalização de página da Web do ASP.NET)