PackageRegistrationAttribute Class

Article
02/04/2013

Modify your class that implements IVsPackage by using this attribute so that the registration tool, RegPkg.exe, will look for additional attributes. For more information, see Registering VSPackages.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class PackageRegistrationAttribute extends RegistrationAttribute

The PackageRegistrationAttribute type exposes the following members.

Constructors

	Name	Description
	PackageRegistrationAttribute	Initializes an instance of this attribute.

Top

Properties

	Name	Description
	RegisterUsing	Gets or sets the method of registration.
	SatellitePath	Gets or sets the non-default resource .dll location.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)
	UseManagedResourcesOnly	Gets or sets whether package resources are described in a managed package or in a satellite UI .dll file.

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.)
	GetPackageRegKeyPath	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute.)
	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.)
	Register	Creates registry entries that correspond to the value of this attribute. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes attribute-specific registry entries. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

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

RegPkg.exe uses C# reflection to determine the attributes that modify your assembly-implemented package. RegPkg.exe then evaluates each attribute by using information that is specific to the current installation, and then creates registry entries that describe the package to Visual Studio. If your class inherits from the Managed Package Framework (MPF) class Package, this attribute is already included. If you create your own class that implements IVsPackage, manually modify your class by using one PackageRegistrationAttribute or the package will not load.

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