DisplayNameAttribute Class
 

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

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDisplayNameAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event)]
public class DisplayNameAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Method | AttributeTargets::Property | AttributeTargets::Event)]
public ref class DisplayNameAttribute : Attribute
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event)>]
type DisplayNameAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Event)>
Public Class DisplayNameAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod DisplayNameAttribute

Initializes a new instance of the DisplayNameAttribute class.

System_CAPS_pubmethod DisplayNameAttribute

Initializes a new instance of the DisplayNameAttribute class using the display name.

Properties
NameDescription
System_CAPS_pubproperty

Gets the display name for a property, event, or public void method that takes no arguments stored in this attribute.

System_CAPS_protproperty

Gets or sets the display name.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods
NameDescription
System_CAPS_pubmethod Equals

Determines whether two DisplayNameAttribute instances are equal.(Overrides AttributeEquals.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

Determines if this attribute is the default.(Overrides AttributeIsDefaultAttribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Fields
NameDescription
System_CAPS_pubfield System_CAPS_static Default

Specifies the default value for the DisplayNameAttribute. This field is read-only.

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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 bool MisnamedProperty
{
    get
    {
        return true;
    }
}
' 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
Version Information
.NET Framework
Available since 2.0
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.

Return to top