.NET Framework Class Library
DisplayFormatAttribute Class

Specifies how data fields are displayed and formatted by ASP.NET Dynamic Data.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModel.DataAnnotationsDisplayFormatAttribute

Namespace:   System.ComponentModel.DataAnnotations
Assemblies:   System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
  System.ComponentModel.Annotations (in System.ComponentModel.Annotations.dll)
Syntax
<[%$TOPIC/cc679253_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/cc679253_en-us_VS_110_2_0_0_0_1%].Property Or [%$TOPIC/cc679253_en-us_VS_110_2_0_0_0_2%].Field, AllowMultiple := False)> _
Public Class DisplayFormatAttribute _
	Inherits [%$TOPIC/cc679253_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/cc679253_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/cc679253_en-us_VS_110_2_0_1_0_1%].Property|[%$TOPIC/cc679253_en-us_VS_110_2_0_1_0_2%].Field, AllowMultiple = false)]
public class DisplayFormatAttribute : [%$TOPIC/cc679253_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/cc679253_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/cc679253_en-us_VS_110_2_0_2_0_1%]::Property|[%$TOPIC/cc679253_en-us_VS_110_2_0_2_0_2%]::Field, AllowMultiple = false)]
public ref class DisplayFormatAttribute : public [%$TOPIC/cc679253_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/cc679253_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/cc679253_en-us_VS_110_2_0_3_0_1%].Property|[%$TOPIC/cc679253_en-us_VS_110_2_0_3_0_2%].Field, AllowMultiple = false)>]
type DisplayFormatAttribute =  
    class 
        inherit [%$TOPIC/cc679253_en-us_VS_110_2_0_3_0_3%] 
    end

The DisplayFormatAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps DisplayFormatAttributeInitializes a new instance of the DisplayFormatAttribute class.
Top
Properties
  NameDescription
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps ApplyFormatInEditModeGets 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.
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps ConvertEmptyStringToNullGets or sets a value that indicates whether empty string values ("") are automatically converted to when the data field is updated in the data source.
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps DataFormatStringGets or sets the display format for the field value.
Public property HtmlEncodeGets or sets a value that indicates whether the field should be HTML-encoded.
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps NullDisplayTextGets or sets the text that is displayed for a field when the field's value is .
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Supported by Portable Class Library Supported in .NET for Windows Store apps FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method Supported by Portable Class Library Supported in .NET for Windows Store apps MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

When you apply this attribute to a data field, you must follow the guidelines for the use of the attributes. For more information, see ASP.NET Dynamic Data Guidelines.

Examples

See an online example of this feature: Run.

The following example shows how to use the DisplayFormatAttribute to customize formatting for a data field. The example performs the following steps:

  • Implements a metadata partial class and an associated metadata class.

  • In the associated metadata class, it applies the DisplayFormatAttribute attribute to specify the following results:

    • Display the text "[Null]" when a data field is empty.

    • Display currency data in locale specific currency format.

    • Display date information in short format (mm/dd/yy). This format also applies in edit mode.

Imports System
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
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;
}

To compile the example, you need the following:

  • Microsoft Visual Studio 2008 Service Pack 1 or Visual Web Developer 2008 Express Edition Service Pack 1.

  • The AdventureWorksLT sample database. For information about how to download and install the SQL Server sample database, see Microsoft SQL Server Product Samples: Database on the CodePlex site. Make sure that you install the correct version of the sample database for the version of SQL Server that you are running (Microsoft SQL Server 2005 or Microsoft SQL Server 2008).

  • A data-driven Web site. This enables you to create a data context for the database and the class that contains the data field to customize. For more information, see Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.