.NET Framework Class Library
DisplayNameAttribute Class

Specifies the display name for a property, event, or public void method which takes no arguments.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDisplayNameAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_1%].Class Or [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_2%].Method Or [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_3%].Property Or [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_4%].Event)> _
Public Class DisplayNameAttribute _
	Inherits [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_0_0_5%]
[[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_1%].Class|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_2%].Method|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_3%].Property|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_4%].Event)]
public class DisplayNameAttribute : [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_1_0_5%]
[[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_1%]::Class|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_2%]::Method|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_3%]::Property|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_4%]::Event)]
public ref class DisplayNameAttribute : public [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_2_0_5%]
[<[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_1%].Class|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_2%].Method|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_3%].Property|[%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_4%].Event)>]
type DisplayNameAttribute =  
    class 
        inherit [%$TOPIC/f6yh8e73_en-us_VS_110_2_0_3_0_5%] 
    end

The DisplayNameAttribute type exposes the following members.

Constructors
  NameDescription
Public method DisplayNameAttributeInitializes a new instance of the DisplayNameAttribute class.
Public method DisplayNameAttribute(String)Initializes a new instance of the DisplayNameAttribute class using the display name.
Top
Properties
  NameDescription
Public property DisplayNameGets the display name for a property, event, or public void method that takes no arguments stored in this attribute.
Protected property DisplayNameValueGets or sets the display name.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsDetermines whether two DisplayNameAttribute instances are equal. (Overrides AttributeEquals(Object).)
Protected method 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 GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines if this attribute is the default. (Overrides AttributeIsDefaultAttribute.)
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 MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value for the DisplayNameAttribute. This field is read-only.
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

The default is the name of the property or event. The default implementation of GetSortedActionItems uses reflection to search the public properties and public void methods that take no arguments. GetSortedActionItems searches for the DisplayNameAttribute on each property and method and, if found, uses that string instead of the property or method name.

Examples

The following code example demonstrates using the DisplayNameAttribute class to change the name of a property called MisnamedProperty to RenamedProperty in a PropertyGrid control. For a full code listing, see How to: Apply Attributes in Windows Forms Controls.

' This property exists only to demonstrate the  
' DisplayName attribute. When this control  
' is attached to a PropertyGrid control, the 
' property will be appear as "RenamedProperty" 
' instead of "MisnamedProperty".
<Description("Demonstrates DisplayNameAttribute."), _
DisplayName("RenamedProperty")> _
Public ReadOnly Property MisnamedProperty() As Boolean 
    Get 
        Return True 
    End Get 
End Property
// This property exists only to demonstrate the  
// DisplayName attribute. When this control  
// is attached to a PropertyGrid control, the 
// property will be appear as "RenamedProperty" 
// instead of "MisnamedProperty".
[Description("Demonstrates DisplayNameAttribute.")]
[DisplayName("RenamedProperty")]
public bool MisnamedProperty
{
    get
    {
        return true;
    }
}
Version Information

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
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.