ProvideExtenderAttribute Class

Article
04/29/2015

Provides an extender for Visual Studio. This class cannot be inherited.

Inheritance Hierarchy

Object
  Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideExtenderAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideExtenderAttribute _
    Inherits RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideExtenderAttribute : RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class ProvideExtenderAttribute sealed : public RegistrationAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type ProvideExtenderAttribute =  
    class 
        inherit RegistrationAttribute 
    end

public final class ProvideExtenderAttribute extends RegistrationAttribute

The ProvideExtenderAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideExtenderAttribute	Initializes a new instance of ProvideExtenderAttribute for the specified extender.

Top

Properties

	Name	Description
	ExtendeeCatId	Gets the GUID category ID of the element to be extended.
	Extender	Gets the GUID of the extender.
	ExtenderName	Gets the name of the extender.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	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.)
	Register	Provides registration information about a VSPackage when called by an external registration tool such as RegPkg.exe. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes registration information about a VSPackage when called by an external registration tool such as RegPkg.exe. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

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

Top

Remarks

This attribute provides an extender (an object that implements IExtenderProvider) with Visual Studio. To use ProvideExtenderAttribute, place it on a class that inherits from Package or implements IVsPackage.

This attribute class is used only to provide data for external registration tools. It does not have any effect on the runtime behavior of the VSPackage.

Note

C# automatically appends the word "Attribute" to the name of any attribute class. In C# code, refer to this attribute as ProvideExtender.

Note

The GUIDs for the Visual C# and Visual Basic project types are {FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} and {F184B08F-C81C-45F6-A57F-5ABD9991F28F}, respectively.

When to Call

Apply ProvideExtenderAttribute when your VSPackage implements a static extender.

Registry Entries

The following registry entries are created by ProvideExtenderAttribute:

<VSROOT>\Extenders\{CATID}\EditorName\
<VSROOT>\Extenders\{CATID}\EditorName\@={ExtenderGuid}

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.