DisplayFormatAttribute Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Especifica como os campos de dados são exibidos e formatados pelos 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
- Atributos
Exemplos
O exemplo seguinte mostra como usar o DisplayFormatAttribute para personalizar a formatação de um campo de dados. O exemplo executa os seguintes passos:
Implementa uma classe parcial de metadados e uma classe de metadados associada.
Na classe de metadados associada, aplica-se o DisplayFormatAttribute atributo para especificar os seguintes resultados:
- Mostrar o texto "[Null]" quando um campo de dados estiver vazio.
- Mostrar dados de moeda num formato monetário específico da localidade.
- Mostrar a informação da data em formato curto (mm/dd/aa). Este 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, precisa do seguinte:
- Qualquer edição do Visual Studio 2010 ou posterior.
- A base de dados de exemplos AdventureWorksLT. Para informações sobre como descarregar e instalar a base de dados de exemplos SQL Server, consulte Microsoft SQL Server Product Samples: Database no GitHub. Certifica-te de que instalas a versão correta da base de dados de exemplo para a versão do SQL Server que estás a usar.
- Um site orientado por dados. Isto permite-lhe criar um contexto de dados para a base de dados e a classe que contém o campo de dados para personalizar. Para obter mais informações, veja
Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.
Observações
Quando aplica este atributo a um campo de dados, deve seguir as orientações para a utilização dos atributos. Para mais informações, consulte ASP.NET Diretrizes de Dados Dinâmicos.
Construtores
| Name | Description |
|---|---|
| DisplayFormatAttribute() |
Inicializa uma nova instância da DisplayFormatAttribute classe. |
Propriedades
| Name | Description |
|---|---|
| ApplyFormatInEditMode |
Recebe ou define um valor que indica se a cadeia de formatação especificada pela DataFormatString propriedade é aplicada ao valor do campo quando o campo de dados está em modo de edição. |
| ConvertEmptyStringToNull |
Recebe ou define um valor que indica se os valores de string vazios ("") são automaticamente convertidos quando |
| DataFormatString |
Obtém ou definem o formato de exibição para o valor do campo. |
| HtmlEncode |
Recebe ou define um valor que indica se o campo deve ser codificado em HTML. |
| NullDisplayText |
Obtém ou define o texto que é exibido para um campo quando o valor do campo é |
| TypeId |
Quando implementado numa classe derivada, obtém um identificador único para esta Attribute. (Herdado de Attribute) |
Métodos
| Name | Description |
|---|---|
| Equals(Object) |
Devolve um valor que indica se esta instância é igual a um objeto especificado. (Herdado de Attribute) |
| GetHashCode() |
Devolve o código de hash para esta instância. (Herdado de Attribute) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| IsDefaultAttribute() |
Quando sobrescrito numa classe derivada, indica se o valor desta instância é o valor padrão para a classe derivada. (Herdado de Attribute) |
| Match(Object) |
Quando sobrescrito numa classe derivada, devolve um valor que indica se esta instância é igual a um objeto especificado. (Herdado de Attribute) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |
Implementações de Interface Explícita
| Name | Description |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de despacho. (Herdado de Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Recupera a informação de tipo de um objeto, que pode ser usada para obter a informação de tipo para uma interface. (Herdado de Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Recupera o número de interfaces de informações de tipo que um objeto fornece (0 ou 1). (Herdado de Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Proporciona acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute) |