DisplayAttribute Class

Definition

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

C#
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class DisplayAttribute : Attribute
C#
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class DisplayAttribute : Attribute
Inheritance
DisplayAttribute
Attributes

Remarks

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

Constructors

DisplayAttribute()

Initializes a new instance of the DisplayAttribute class.

Properties

AutoGenerateField

Gets or sets a value that indicates whether UI should be generated automatically in order to display this field.

AutoGenerateFilter

Gets or sets a value that indicates whether filtering UI is automatically displayed for this field.

Description

Gets or sets a value that is used to display a description in the UI.

GroupName

Gets or sets a value that is used to group fields in the UI.

Name

Gets or sets a value that is used for display in the UI.

Order

Gets or sets the order weight of the column.

Prompt

Gets or sets a value that will be used to set the watermark for prompts in the UI.

ResourceType

Gets or sets the type that contains the resources for the ShortName, Name, Prompt, and Description properties.

ShortName

Gets or sets a value that is used for the grid column label.

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetAutoGenerateField()

Returns the value of the AutoGenerateField property.

GetAutoGenerateFilter()

Returns a value that indicates whether UI should be generated automatically in order to display filtering for this field.

GetDescription()

Returns the value of the Description property.

GetGroupName()

Returns the value of the GroupName property.

GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetName()

Returns a value that is used for field display in the UI.

GetOrder()

Returns the value of the Order property.

GetPrompt()

Returns the value of the Prompt property.

GetShortName()

Returns the value of the ShortName property.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
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)
Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Maps a set of names to a corresponding set of dispatch identifiers.

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

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)

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)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided), 2.1 (package-provided)
UWP 10.0