DisplayFormatAttribute Klasse

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Quelle:

DisplayFormatAttribute.cs

Gibt an, wie Datenfelder von ASP.NET Dynamic Data angezeigt und formatiert werden.

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

Vererbung

Object

Attribute

DisplayFormatAttribute

Attribute

AttributeUsageAttribute

Beispiele

Sehen Sie sich ein Onlinebeispiel für dieses Feature an: Ausführen.

Im folgenden Beispiel wird gezeigt, wie Die Formatierung für ein Datenfeld mithilfe von DisplayFormatAttribute angepasst wird. Im Beispiel werden die folgenden Schritte ausgeführt:

• Implementiert eine partielle Metadatenklasse und eine zugeordnete Metadatenklasse.

• In der zugeordneten Metadatenklasse wendet sie das DisplayFormatAttribute -Attribut an, um die folgenden Ergebnisse anzugeben:

  • Zeigt den Text "[Null]" an, wenn ein Datenfeld leer ist.

  • Währungsdaten im gebietsschemaspezifischen Währungsformat anzeigen.

  • Datumsinformationen im Kurzformat anzeigen (mm/TT/jj). Dieses Format gilt auch im Bearbeitungsmodus.

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

Um das Beispiel zu kompilieren, benötigen Sie Folgendes:

• Jede Edition von Visual Studio 2010 oder höher.

• Die AdventureWorksLT-Beispieldatenbank. Informationen zum Herunterladen und Installieren der SQL Server Beispieldatenbank finden Sie unter Microsoft SQL Server-Produktbeispiele: Datenbank auf GitHub. Stellen Sie sicher, dass Sie die richtige Version der Beispieldatenbank für die Version von SQL Server installieren, die Sie ausführen.

• Eine datengesteuerte Website. Dadurch können Sie einen Datenkontext für die Datenbank und die Klasse erstellen, die das anzupassende Datenfeld enthält. Weitere Informationen finden Sie unter Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Hinweise

Wenn Sie dieses Attribut auf ein Datenfeld anwenden, müssen Sie die Richtlinien für die Verwendung der Attribute befolgen. Weitere Informationen finden Sie unter Richtlinien für ASP.NET dynamische Daten.

Konstruktoren

DisplayFormatAttribute()

Initialisiert eine neue Instanz der DisplayFormatAttribute-Klasse.

Eigenschaften

ApplyFormatInEditMode	Ruft einen Wert ab, der angibt, ob die von der DataFormatString-Eigenschaft angegebene Formatierungszeichenfolge auf den Feldwert angewendet wird, wenn sich das Datenfeld im Bearbeitungsmodus befindet, oder legt diesen fest.
ConvertEmptyStringToNull	Ruft einen Wert ab, der angibt, ob bei der Aktualisierung des Datenfelds in der Datenquelle Werte, die leere Zeichenfolgen ("") darstellen, in null konvertiert werden, oder legt diesen fest.
DataFormatString	Ruft das Anzeigeformat für den Feldwert ab oder legt ihn fest.
HtmlEncode	Ruft einen Wert ab, der angibt, ob das Feld HTML-codiert sein muss, oder legt diesen Wert fest.
NullDisplayText	Ruft den Text ab, der für ein Feld angezeigt wird, wenn der Wert des Felds null ist, oder legt diesen fest.
NullDisplayTextResourceType	Ruft den Type ab, der die Ressourcen für NullDisplayText enthält, oder legt diesen fest. Die Verwendung von NullDisplayTextResourceType zusammen mit NullDisplayText ermöglicht der GetNullDisplayText()-Methode, lokalisierte Werte zurückzugeben.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetNullDisplayText()	Gibt die Zeichenfolge zur Anzeige in der Benutzeroberfläche für NullDisplayText zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Vorgehensweise: Festlegen der Kultur und Benutzeroberflächenkultur für die Globalisierung von ASP.NET-Webseiten