DisplayNameResourceAttribute Class

Article
02/04/2013

Represents the name associated with a property.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.ComponentModel.DisplayNameAttribute
      Microsoft.VisualStudio.Modeling.Design.DisplayNameResourceAttribute

Namespace: Microsoft.VisualStudio.Modeling.Design
Assembly: Microsoft.VisualStudio.Modeling.Sdk.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.10.0.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Property, AllowMultiple := False)> _
Public NotInheritable Class DisplayNameResourceAttribute _
    Inherits DisplayNameAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Property, AllowMultiple = false)]
public sealed class DisplayNameResourceAttribute : DisplayNameAttribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Property, AllowMultiple = false)]
public ref class DisplayNameResourceAttribute sealed : public DisplayNameAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Property, AllowMultiple = false)>]
type DisplayNameResourceAttribute =  
    class
        inherit DisplayNameAttribute
    end

public final class DisplayNameResourceAttribute extends DisplayNameAttribute

The DisplayNameResourceAttribute type exposes the following members.

Constructors

	Name	Description
	DisplayNameResourceAttribute(String, Type)	Initializes a new instance of the DisplayNameResourceAttribute class by using the specified display name key and type.
	DisplayNameResourceAttribute(String, Type, String)	Initializes a new instance of the DisplayNameResourceAttribute class by using the specified display-name key, type, and resources name.

Top

Properties

	Name	Description
	DisplayName	Gets the display name, which is localized to the current culture. (Overrides DisplayNameAttribute.DisplayName.)
	DisplayNameKey	Gets the key of the display-name resource entry in the specified resource.
	DisplayNameValue	Gets or sets the display name. (Inherited from DisplayNameAttribute.)
	ResourceName	Gets the root name of the resource.
	Type	Gets the type that identifies the assembly that contains the resource.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Determines whether two DisplayNameAttribute instances are equal. (Inherited from DisplayNameAttribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DisplayNameAttribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	Determines if this attribute is the default. (Inherited from DisplayNameAttribute.)
	Match	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.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

The name is used to identify the target property in various user interface contexts, such as when the property is shown in a PropertyGrid control.

The DisplayName property of this class gets the description string resource that is localized to the current culture. If a localized string is not available, then the DisplayName property returns the value of the DisplayNameKey property.

When you design a domain-specific language (DSL), the generated code applies this attribute to every property that corresponds to a domain property in the DSL definition.

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.