DisplayFormatAttribute Klasa

Definicja

Przestrzeń nazw:

System.ComponentModel.DataAnnotations

Zestaw:

System.ComponentModel.Annotations.dll

Źródło:

DisplayFormatAttribute.cs

Określa sposób wyświetlania i formatowania pól danych przez ASP.NET danych dynamicznych.

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

Dziedziczenie

Object

Attribute

DisplayFormatAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie pokazano, jak dostosować formatowanie pola danych przy użyciu DisplayFormatAttribute elementu . W przykładzie są wykonywane następujące kroki:

• Implementuje klasę częściową metadanych i skojarzą klasę metadanych.

• W skojarzonej klasie metadanych stosuje DisplayFormatAttribute atrybut w celu określenia następujących wyników:

  • Wyświetl tekst "[Null]", gdy pole danych jest puste.
  • Wyświetl dane waluty w formacie waluty specyficznej dla ustawień regionalnych.
  • Wyświetl informacje o dacie w formacie krótkim (mm/dd/yy). Ten format ma również zastosowanie w trybie edycji.

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

Aby skompilować przykład, potrzebne są następujące elementy:

• Dowolna wersja Visual Studio 2010 lub nowsza.
• Przykładowa baza danych AdventureWorksLT. Aby uzyskać informacje na temat pobierania i instalowania przykładowej bazy danych SQL Server, zobacz Microsoft SQL Server Przykłady produktów: Database on GitHub. Upewnij się, że zainstalowano poprawną wersję przykładowej bazy danych dla wersji SQL Server, która jest uruchomiona.
• Witryna sieci Web oparta na danych. Dzięki temu można utworzyć kontekst danych dla bazy danych i klasy zawierającej pole danych do dostosowania. Aby uzyskać więcej informacji, zobacz Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Uwagi

Po zastosowaniu tego atrybutu do pola danych należy postępować zgodnie z wytycznymi dotyczącymi używania atrybutów.

Konstruktory

Nazwa	Opis
DisplayFormatAttribute()	Inicjuje nowe wystąpienie klasy DisplayFormatAttribute.

Właściwości

Nazwa	Opis
ApplyFormatInEditMode	Pobiera lub ustawia wartość wskazującą, czy ciąg formatowania określony przez DataFormatString właściwość jest stosowany do wartości pola, gdy pole danych jest w trybie edycji.
ConvertEmptyStringToNull	Pobiera lub ustawia wartość wskazującą, czy puste wartości ciągu ("") są automatycznie konwertowane na null czas aktualizowania pola danych w źródle danych.
DataFormatString	Pobiera lub ustawia format wyświetlania wartości pola.
HtmlEncode	Pobiera lub ustawia wartość wskazującą, czy pole powinno być zakodowane w formacie HTML.
NullDisplayText	Pobiera lub ustawia tekst wyświetlany dla pola, gdy wartość pola to null.
NullDisplayTextResourceType	Pobiera lub ustawia element Type zawierający zasoby dla elementu NullDisplayText. Użycie NullDisplayTextResourceType funkcji wraz z NullDisplayTextmetodą umożliwia metodzie GetNullDisplayText() zwracanie zlokalizowanych wartości.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attribute. (Odziedziczone po Attribute)

Metody

Nazwa	Opis
Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca kod skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetNullDisplayText()	Zwraca ciąg wyświetlania interfejsu użytkownika dla elementu NullDisplayText.
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Po zastąpieniu w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną dla klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	Po zastąpieniu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)