Share via


RegistrationAttribute Class

An abstract class for VSPackage registration. The RegistrationAttribute class allows new registration information to be added without changing the registration tools.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      More...

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.Immutable.10.0 (in Microsoft.VisualStudio.Shell.Immutable.10.0.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public MustInherit Class RegistrationAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Class)]
public abstract class RegistrationAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class RegistrationAttribute abstract : public Attribute
[<AbstractClass>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type RegistrationAttribute =  
    class
        inherit Attribute
    end
public abstract class RegistrationAttribute extends Attribute

The RegistrationAttribute type exposes the following members.

Constructors

  Name Description
Protected method RegistrationAttribute Initializes a new instance of the class.

Top

Properties

  Name Description
Public property TypeId Gets the current instance of this attribute. (Overrides Attribute.TypeId.)

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Protected method GetPackageRegKeyPath Gets the registry path (relative to the registry root of the application) of the VSPackage.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Register Registers this VSPackage with a given context, when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Unregister Called to unregister this attribute with the given context.

Top

Explicit Interface Implementations

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

Top

Remarks

When to Implement

Derive a registration attribute from RegistrationAttribute to create a class that makes specialized registry entries when applied to your Package-derived class or a class that implements IVsPackage.

Basic Usage

Attribute classes that provide VSPackage registration information. Regpkg.exe or other registration tools must derive from and implement RegistrationAttribute. For more information, see Registering VSPackages.

RegistrationAttribute is an abstract attribute class that enables VSPackage developers to add registration attribute classes without needing to change the registration tools.

Attribute classes that provide registration information to regpkg.exe or other registration tools must derive from RegistrationAttribute, and must implement the Register and Unregister abstract methods.

Registration tools such as regpkg.exe must implement the classes RegistrationAttribute.Key and RegistrationAttribute.RegistrationContext.

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.

See Also

Reference

Microsoft.VisualStudio.Shell Namespace

Other Resources

VSPackage Registration

Managed Package Registration

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.Internal.VisualStudio.PlatformUI.ProvideUIDataConverterAttribute
      Microsoft.Internal.VisualStudio.PlatformUI.ProvideUIDataSourceProviderAttribute
      Microsoft.Internal.VisualStudio.PlatformUI.ProvideUIProviderAttribute
      Microsoft.VisualStudio.Shell.Design.DesignSurfaceExtensionAttribute
      Microsoft.VisualStudio.Shell.Design.ProvideDesignerMetadataAttribute
      Microsoft.VisualStudio.Shell.Design.ProvideDesignerOptionsAttribute
      Microsoft.VisualStudio.Shell.Design.ProvideGlobalObjectProviderAttribute
      Microsoft.VisualStudio.Shell.Design.ProvideViewAdapterAttribute
      Microsoft.VisualStudio.Shell.Design.Serialization.ProvideDesignerLoaderAttribute
      Microsoft.VisualStudio.Shell.Design.Serialization.ProvideGeneratorAttribute
      Microsoft.VisualStudio.Shell.InstalledProductRegistrationAttribute
      Microsoft.VisualStudio.Shell.PackageRegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideAutoLoadAttribute
      Microsoft.VisualStudio.Shell.ProvideAutomationObjectAttribute
      Microsoft.VisualStudio.Shell.ProvideEditorExtensionAttribute
      Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute
      Microsoft.VisualStudio.Shell.ProvideEditorLogicalViewAttribute
      Microsoft.VisualStudio.Shell.ProvideExtenderAttribute
      Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute
      Microsoft.VisualStudio.Shell.ProvideLanguageCodeExpansionAttribute
      Microsoft.VisualStudio.Shell.ProvideLanguageEditorToolsOptionCategoryAttribute
      Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute
      Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute
      Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute
      Microsoft.VisualStudio.Shell.ProvideMenuResourceAttribute
      Microsoft.VisualStudio.Shell.ProvideObjectAttribute
      Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute
      Microsoft.VisualStudio.Shell.ProvideProfileAttribute
      Microsoft.VisualStudio.Shell.ProvideProjectFactoryAttribute
      Microsoft.VisualStudio.Shell.ProvideProjectItemAttribute
      Microsoft.VisualStudio.Shell.ProvideServiceAttribute
      Microsoft.VisualStudio.Shell.ProvideStaticToolboxGroupAttribute
      Microsoft.VisualStudio.Shell.ProvideStaticToolboxItemAttribute
      Microsoft.VisualStudio.Shell.ProvideToolboxItemConfigurationAttribute
      Microsoft.VisualStudio.Shell.ProvideToolboxItemsAttribute
      Microsoft.VisualStudio.Shell.ProvideToolWindowAttribute
      Microsoft.VisualStudio.Shell.ProvideToolWindowVisibilityAttribute
      Microsoft.VisualStudio.Shell.RegisterAutoLoadAttribute
      Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute
      Microsoft.VisualStudio.Shell.RegisterEditorLogicalViewAttribute
      Microsoft.VisualStudio.Shell.RegisterExtenderAttribute
      Microsoft.VisualStudio.Shell.RegisterLanguageExtensionAttribute
      Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute
      Microsoft.VisualStudio.Shell.RegisterProjectItemAttribute