DisplayFormatAttribute Clase

Definición

Especifica cómo se muestran y da formato a los campos de datos ASP.NET datos dinámicos.

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
Herencia
DisplayFormatAttribute
Atributos

Ejemplos

En el ejemplo siguiente se muestra cómo usar para personalizar el DisplayFormatAttribute formato de un campo de datos. En el ejemplo se realizan los pasos siguientes:

  • Implementa una clase parcial de metadatos y una clase de metadatos asociada.

  • En la clase de metadatos asociada, aplica el DisplayFormatAttribute atributo para especificar los siguientes resultados:

    • Muestra el texto "[Null]" cuando un campo de datos está vacío.
    • Mostrar datos de moneda en formato de moneda específico de configuración regional.
    • Mostrar información de fecha en formato corto (mm/dd/aaaa). Este formato también se aplica en modo de edición.
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 el ejemplo, necesita lo siguiente:

  • Cualquier edición de Visual Studio 2010 o posterior.
  • Base de datos de ejemplo AdventureWorksLT. Para obtener información sobre cómo descargar e instalar la base de datos de ejemplo de SQL Server, vea Microsoft SQL Server Product Samples: Database on GitHub. Asegúrese de instalar la versión correcta de la base de datos de ejemplo para la versión de SQL Server que está ejecutando.
  • Un sitio web controlado por datos. Esto le permite crear un contexto de datos para la base de datos y la clase que contiene el campo de datos que se va a personalizar. Para obtener más información, consulte Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Comentarios

Al aplicar este atributo a un campo de datos, debe seguir las instrucciones para el uso de los atributos.

Constructores

Nombre Description
DisplayFormatAttribute()

Inicializa una nueva instancia de la clase DisplayFormatAttribute.

Propiedades

Nombre Description
ApplyFormatInEditMode

Obtiene o establece un valor que indica si la cadena de formato especificada por la DataFormatString propiedad se aplica al valor de campo cuando el campo de datos está en modo de edición.

ConvertEmptyStringToNull

Obtiene o establece un valor que indica si los valores de cadena vacíos ("") se convierten automáticamente en null cuando el campo de datos se actualiza en el origen de datos.

DataFormatString

Obtiene o establece el formato de presentación para el valor del campo.

HtmlEncode

Obtiene o establece un valor que indica si el campo debe estar codificado en HTML.

NullDisplayText

Obtiene o establece el texto que se muestra para un campo cuando el valor del campo es null.

NullDisplayTextResourceType

Obtiene o establece el Type objeto que contiene los recursos de NullDisplayText.

Con NullDisplayTextResourceType junto con NullDisplayText, permite que el GetNullDisplayText() método devuelva valores localizados.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.

(Heredado de Attribute)

Métodos

Nombre Description
Equals(Object)

Devuelve un valor que indica si esta instancia es igual a un objeto especificado.

(Heredado de Attribute)
GetHashCode()

Devuelve el código hash de esta instancia.

(Heredado de Attribute)
GetNullDisplayText()

Devuelve la cadena de presentación de la interfaz de usuario para NullDisplayText.

GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
IsDefaultAttribute()

Cuando se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.

(Heredado de Attribute)
Match(Object)

Cuando se reemplaza en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del Objectactual.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Implementaciones de interfaz explícitas

Nombre Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.

(Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera la información de tipo de un objeto, que se puede usar para obtener la información de tipo de una interfaz.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).

(Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a propiedades y métodos expuestos por un objeto .

(Heredado de Attribute)

Se aplica a