DescriptionResourceAttribute Class

Article
02/04/2013

Represents a property description for a property when the property is displayed in a PropertyGrid control.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.ComponentModel.DescriptionAttribute
      Microsoft.VisualStudio.Modeling.Design.DescriptionResourceAttribute

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 Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class DescriptionResourceAttribute _
    Inherits DescriptionAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
public sealed class DescriptionResourceAttribute : DescriptionAttribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Property|AttributeTargets::Field, AllowMultiple = false)]
public ref class DescriptionResourceAttribute sealed : public DescriptionAttribute

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

public final class DescriptionResourceAttribute extends DescriptionAttribute

The DescriptionResourceAttribute type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Description	Gets the description, localized to the current culture. (Overrides DescriptionAttribute.Description.)
	DescriptionKey	Gets the key of the description resource entry in the specified resource.
	DescriptionValue	Gets or sets the string stored as the description. (Inherited from DescriptionAttribute.)
	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	Returns whether the value of the given object is equal to the current DescriptionAttribute. (Inherited from DescriptionAttribute.)
	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 DescriptionAttribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	Returns a value indicating whether this is the default DescriptionAttribute instance. (Inherited from DescriptionAttribute.)
	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 Description 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 Description property returns the value of the DescriptionKey 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.

Share via