ProvideLoadKeyAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This attribute provides a package load key for your package. Not needed in Visual Studio 2010.

public ref class ProvideLoadKeyAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

public ref class ProvideLoadKeyAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)]
public sealed class ProvideLoadKeyAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)>]
type ProvideLoadKeyAttribute = class
    inherit RegistrationAttribute

Public NotInheritable Class ProvideLoadKeyAttribute
Inherits RegistrationAttribute

Inheritance: Attribute

RegistrationAttribute
ProvideLoadKeyAttribute

Attributes: AttributeUsageAttribute

Remarks

Important

Packages that target Visual Studio 2010 only do not need a package load key.

Packages that target Visual Studio 2008 and earlier must have a package load key in order to validate and load VSPackages. This includes VSPackages provided by third parties, regardless of whether the hosting version of Visual Studio has a VSIP license.

Developers can load their own VSPackages without package load key if they have a valid VSIP developer license.

This attribute class is used only to provide data for external registration tools like regpkg.exe. It does not have any effect on the runtime behavior of the VSPackage. For more information, see Registering VSPackages.

Note

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

When to Call

For VSPackages that target Visual Studio 2008 and earlier, apply this attribute to your Package-derived class or class that implements IVsPackage to define its package load key. A package load key is used by Visual Studio to validate that a package can be loaded.

Constructors

ProvideLoadKeyAttribute(String, String, String, String, Int16)

Creates a new ProvideLoadKeyAttribute.

Properties

CompanyName	Gets the company name.
MinimumEdition	Gets the minimum edition of Visual Studio needed to load your VSPackage.
ProductName	Gets the name of your VSPackage.
ProductVersion	Gets the version number of your VSPackage.
ResourceId	Gets the resource ID for the Package Load Key.
TypeId	Override the TypeID property in order to let the RegistrationAttribute derived classes to work with System.ComponentModel.TypeDescriptor.GetAttributes(...). An attribute derived from this one will have to override this property only if it needs a better control on the instances that can be applied to a class. (Inherited from RegistrationAttribute)

Methods

GetPackageRegKeyPath(Guid)	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe.
RegKeyName(RegistrationAttribute+RegistrationContext)	Registry Key name for this package's load key information.
Unregister(RegistrationAttribute+RegistrationContext)	Unregisters this package's load key information

Applies to

Share via