GlobalObjectDescriptionAttribute Class

Article
02/04/2013

Allows global object providers to tag the global object instances they provide with additional metadata.

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.VisualStudio.Shell.Design.GlobalObjectDescriptionAttribute

Namespace: Microsoft.VisualStudio.Shell.Design
Assembly: Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public Class GlobalObjectDescriptionAttribute _
    Inherits Attribute

[CLSCompliantAttribute(false)]
[AttributeUsageAttribute(AttributeTargets.Class)]
public class GlobalObjectDescriptionAttribute : Attribute

[CLSCompliantAttribute(false)]
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class GlobalObjectDescriptionAttribute : public Attribute

[<CLSCompliantAttribute(false)>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type GlobalObjectDescriptionAttribute =  
    class
        inherit Attribute
    end

public class GlobalObjectDescriptionAttribute extends Attribute

The GlobalObjectDescriptionAttribute type exposes the following members.

Constructors

	Name	Description
	GlobalObjectDescriptionAttribute(GlobalObject)	Initializes a new instance of GlobalObjectDescriptionAttribute for the specified global object.
	GlobalObjectDescriptionAttribute(GlobalObject, IDictionary)	Initializes a new instance of GlobalObjectDescriptionAttribute for the specified global object and custom data.

Top

Properties

	Name	Description
	CustomData	Gets the custom data.
	GlobalObject	Gets the global object to which the custom data should apply.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	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 Attribute.)
	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	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

Provider authors need to document what information they set in this attribute.

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