Home Library Learn Downloads Support Community
Sign in | United States - English | |
1 out of 4 rated this helpful - Rate this topic

DisplayAttribute Class

.NET Framework 4

Provides a general-purpose attribute that lets you specify localizable strings for types and members of entity partial classes.

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.DisplayAttribute

Namespace:  System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
C#
C++
F#
VB
Copy 
[AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = false)]
public sealed class DisplayAttribute : Attribute

The DisplayAttribute type exposes the following members.

  Name Description
Public method DisplayAttribute Initializes a new instance of the DisplayAttribute class.
Top
  Name Description
Public property AutoGenerateField Gets or sets a value that indicates whether UI should be generated automatically in order to display this field.
Public property AutoGenerateFilter Gets or sets a value that indicates whether filtering UI is automatically displayed for this field.
Public property Description Gets or sets a value that is used to display a description in the UI.
Public property GroupName Gets or sets a value that is used to group fields in the UI.
Public property Name Gets or sets a value that is used for display in the UI.
Public property Order Gets or sets the order weight of the column.
Public property Prompt Gets or sets a value that will be used to set the watermark for prompts in the UI.
Public property ResourceType Gets or sets the type that contains the resources for the ShortName, Name, Prompt, and Description properties.
Public property ShortName Gets or sets a value that is used for the grid column label.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAutoGenerateField Returns the value of the AutoGenerateField property.
Public method GetAutoGenerateFilter Returns a value that indicates whether UI should be generated automatically in order to display filtering for this field.
Public method GetDescription Returns the value of the Description property.
Public method GetGroupName Returns the value of the GroupName property.
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetName Returns a value that is used for field display in the UI.
Public method GetOrder Returns the value of the Order property.
Public method GetPrompt Returns the value of the Prompt property.
Public method GetShortName Returns the value of the ShortName property.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When 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 Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves 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 _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The properties of this class can be used either as literals or as resource identifiers for a specified ResourceType instance.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Specifying Name
Is it possible to specify the property inside the resource dictionary not as a string but as a property, i.e.$0 MyResourceType.MyResourceKey and not "MyResourceKey"?
History