DisplayFormatAttribute DisplayFormatAttribute DisplayFormatAttribute DisplayFormatAttribute Class

Definición

Especifica el modo en que los datos dinámicos de ASP.NET muestran y dan formato a los campos de datos.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
Herencia
DisplayFormatAttributeDisplayFormatAttributeDisplayFormatAttributeDisplayFormatAttribute
Atributos

Ejemplos

Vea un ejemplo en línea de esta característica: Ejecute.See an online example of this feature: Run.

En el ejemplo siguiente se muestra cómo utilizar DisplayFormatAttribute para personalizar el formato de un campo de datos.The following example shows how to use the DisplayFormatAttribute to customize formatting for a data field. En el ejemplo se realizan los pasos siguientes:The example performs the following steps:

  • Implementa una clase parcial de metadatos y una clase de metadatos asociada.Implements a metadata partial class and an associated metadata class.

  • En la clase de metadatos asociada, se DisplayFormatAttribute aplica el atributo para especificar los siguientes resultados:In the associated metadata class, it applies the DisplayFormatAttribute attribute to specify the following results:

    • Muestra el texto "[null]" cuando un campo de datos está vacío.Display the text "[Null]" when a data field is empty.

    • Mostrar datos de moneda en formato de moneda específico de la configuración regional.Display currency data in locale specific currency format.

    • Mostrar información de fecha en formato corto (MM/DD/AA).Display date information in short format (mm/dd/yy). Este formato también se aplica en el modo de edición.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

Para compilar el ejemplo, necesita lo siguiente:To compile the example, you need the following:

  • Cualquier edición de Visual Studio 2010 o posterior.Any edition of Visual Studio 2010 or later.

  • La base de datos de ejemplo AdventureWorksLT.The AdventureWorksLT sample database. 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: Base de datos en github.For information about how to download and install the SQL Server sample database, see 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.Make sure that you install the correct version of the sample database for the version of SQL Server that you are running.

  • Un sitio web controlado por datos.A data-driven Web site. 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.This enables you to create a data context for the database and the class that contains the data field to customize. Para obtener más información, vea Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.For more information, see 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.When you apply this attribute to a data field, you must follow the guidelines for the use of the attributes. Para obtener más información, consulte ASP.NET datos dinámicos instrucciones.For more information, see ASP.NET Dynamic Data Guidelines.

Constructores

DisplayFormatAttribute() DisplayFormatAttribute() DisplayFormatAttribute() DisplayFormatAttribute()

Inicializa una nueva instancia de la clase DisplayFormatAttribute.Initializes a new instance of the DisplayFormatAttribute class.

Propiedades

ApplyFormatInEditMode ApplyFormatInEditMode ApplyFormatInEditMode ApplyFormatInEditMode

Obtiene o establece un valor que indica si la cadena de formato especificada por la propiedad DataFormatString se aplica al valor de campo cuando el campo de datos se encuentra en modo de edición.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 ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull

Obtiene o establece un valor que indica si los valores de cadena vacía ("") se convierten automáticamente en valores null al actualizar el campo de datos en el origen de datos.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 DataFormatString DataFormatString DataFormatString

Obtiene o establece el formato de presentación del valor de campo.Gets or sets the display format for the field value.

HtmlEncode HtmlEncode HtmlEncode HtmlEncode

Obtiene o establece un valor que indica si el campo debe estar codificado en HTML.Gets or sets a value that indicates whether the field should be HTML-encoded.

NullDisplayText NullDisplayText NullDisplayText NullDisplayText

Obtiene o establece el texto que se muestra en un campo cuando el valor del campo es null.Gets or sets the text that is displayed for a field when the field's value is null.

NullDisplayTextResourceType NullDisplayTextResourceType NullDisplayTextResourceType NullDisplayTextResourceType

Obtiene o establece el objeto Type que contiene los recursos para NullDisplayText.Gets or sets the Type that contains the resources for NullDisplayText.

El uso de NullDisplayTextResourceType junto con NullDisplayText permite que el método GetNullDisplayText() devuelva valores localizados.Using NullDisplayTextResourceType along with NullDisplayText, allows the GetNullDisplayText() method to return localized values.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetNullDisplayText() GetNullDisplayText() GetNullDisplayText() GetNullDisplayText()

Devuelve la cadena de representación de la interfaz de usuario para NullDisplayText.Returns the UI display string for NullDisplayText.

GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: