InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute Class

Definition

This attribute registers an 'installed product' for your package.
This enables your package to present information on the VS Splash Screen or Help About.

public ref class InstalledProductRegistrationAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
public ref class InstalledProductRegistrationAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
[System.AttributeUsage(System.AttributeTargets.Class, Inherited=false)]
public sealed class InstalledProductRegistrationAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute
type InstalledProductRegistrationAttribute = class
    inherit RegistrationAttribute
Public NotInheritable Class InstalledProductRegistrationAttribute
Inherits RegistrationAttribute
Inheritance
InstalledProductRegistrationAttributeInstalledProductRegistrationAttributeInstalledProductRegistrationAttributeInstalledProductRegistrationAttributeInstalledProductRegistrationAttribute
Attributes

Remarks

When to Call

Apply this attribute to your VSPackage class to provide information that is displayed on the Visual Studio splash screen and the Help About dialog box.

Basic Usage

Create an InstalledProductRegistrationAttribute object to register your VSPackage with the Help About dialog box. The different constructors provide the options to use the IVsInstalledProduct interface (as implemented by the package) to gather the information and display it on the Visual Studio splash screen. To use this attribute, place it on your VSPackage class (a class derived from Package or one that implements IVsPackage).

This attribute 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 VSPackage Registration.

Note

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

Registry Entries

The following registry entries are created by InstalledProductRegistrationAttribute:

  • <VSROOT>\CLSID\{PackageGuid}

  • <VSROOT>\CLSID\{PackageGuid}\@=ObjectType.FullName

  • <VSROOT>\CLSID\{PackageGuid}\InprocServer32=mscoree.dll

  • <VSROOT>\CLSID\{PackageGuid}\Class=ObjectType.FullName

  • <VSROOT>\CLSID\{PackageGuid}\Assembly=ObjectType.Assembly.FullName

  • <VSROOT>\CLSID\{PackageGuid}\ThreadingModel=Both

  • <VSROOT>\CLSID\{PackageGuid}\CodeBase=context.CodeBase

  • <VSROOT>\CLSID\{PackageGuid}\SatelliteDll

  • <VSROOT>\CLSID\{PackageGuid}\SatelliteDll\Path=SatelliteDllPath

  • <VSROOT>\CLSID\{PackageGuid}\SatelliteDll\DllName=SatelliteDllName

Samples

The standard location for this and all other attributes used for automatic registration is adjacent to the implementation of the Package in VsPkg.cs, VsPkg.vb, or VsPkg.cpp, depending on the language used in the sample.

Constructors

InstalledProductRegistrationAttribute(Boolean, String, String, String) InstalledProductRegistrationAttribute(Boolean, String, String, String) InstalledProductRegistrationAttribute(Boolean, String, String, String) InstalledProductRegistrationAttribute(Boolean, String, String, String) InstalledProductRegistrationAttribute(Boolean, String, String, String)

Creates a new InstalledProductRegistrationAttribute to register your package with Help/About dialog.

InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String)

Creates a new InstalledProductRegistrationAttribute to register your package with Help/About dialog. This is the simplest registration information necessary for 3rd party packages. Providing product details is not a requirement, but is recommended.

InstalledProductRegistrationAttribute(String, String, String, Boolean) InstalledProductRegistrationAttribute(String, String, String, Boolean) InstalledProductRegistrationAttribute(String, String, String, Boolean) InstalledProductRegistrationAttribute(String, String, String, Boolean) InstalledProductRegistrationAttribute(String, String, String, Boolean)

Creates a new InstalledProductRegistrationAttribute to register your package with Help/About dialog.

Properties

IconResourceID IconResourceID IconResourceID IconResourceID IconResourceID

Resource ID of the icon.

LanguageIndependentName LanguageIndependentName LanguageIndependentName LanguageIndependentName LanguageIndependentName

The name of your product.

ProductDetails ProductDetails ProductDetails ProductDetails ProductDetails

Detailed description of your product.

ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID

Resource ID for the details.

ProductId ProductId ProductId ProductId ProductId

Your product ID.

ProductName ProductName ProductName ProductName ProductName

The name of your product.

ProductNameResourceID ProductNameResourceID ProductNameResourceID ProductNameResourceID ProductNameResourceID

Resource ID corresponding to the product name.

TypeId TypeId TypeId TypeId TypeId

Gets the current instance of this attribute.

(Inherited from RegistrationAttribute)
UseInterface UseInterface UseInterface UseInterface UseInterface

Use IVsInstalledProduct to fill in the Help about dialog. The package must implement IVsInstalledProduct.

UsePackage UsePackage UsePackage UsePackage UsePackage

True is the product installation will use the package ID

UseVsProductId UseVsProductId UseVsProductId UseVsProductId UseVsProductId

True is the product ID is the same as VisualStudio ID This is reserved for Microsoft internal use. 3rd party packages should provide their own product ID when the class is constructed.

Methods

GetPackageRegKeyPath(Guid) GetPackageRegKeyPath(Guid) GetPackageRegKeyPath(Guid) GetPackageRegKeyPath(Guid) GetPackageRegKeyPath(Guid)

Gets the registry path (relative to the registry root of the application) of the VSPackage.

(Inherited from RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext) Register(RegistrationAttribute+RegistrationContext) Register(RegistrationAttribute+RegistrationContext) Register(RegistrationAttribute+RegistrationContext) Register(RegistrationAttribute+RegistrationContext)

Called to register this attribute with the given context.

Unregister(RegistrationAttribute+RegistrationContext) Unregister(RegistrationAttribute+RegistrationContext) Unregister(RegistrationAttribute+RegistrationContext) Unregister(RegistrationAttribute+RegistrationContext) Unregister(RegistrationAttribute+RegistrationContext)

Unregister this InstalledProducts entry.

Applies to