InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute InstalledProductRegistrationAttribute Class

Definition

Provides information for the Visual Studio splash screen and the Help About dialog box when applied to a Package-derived class or a class that implements IVsPackage. This class cannot be inherited.

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(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String) InstalledProductRegistrationAttribute(String, String, String)

Initializes a new instance of InstalledProductRegistrationAttribute with the specified product information.

Properties

IconResourceID IconResourceID IconResourceID IconResourceID IconResourceID

Gets or sets the resource ID of the icon associated with the product.

LanguageIndependentName LanguageIndependentName LanguageIndependentName LanguageIndependentName LanguageIndependentName

Gets or sets the (non-localized) name of the product.

ProductDetails ProductDetails ProductDetails ProductDetails ProductDetails

Gets or sets the detailed description of the product.

ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID ProductDetailsResourceID

Gets or sets the product details resource ID.

ProductId ProductId ProductId ProductId ProductId

Gets or sets the product ID.

ProductName ProductName ProductName ProductName ProductName

Gets or sets the name of the product.

ProductNameResourceID ProductNameResourceID ProductNameResourceID ProductNameResourceID ProductNameResourceID

Gets or sets the resource ID of the product name.

TypeId TypeId TypeId TypeId TypeId

Gets the current instance of this attribute.

(Inherited from RegistrationAttribute)
UseInterface UseInterface UseInterface UseInterface UseInterface

Gets or whether the package implements the IVsInstalledProduct interface to display a bitmap in the splash screen and information in the About dialog box on the Help menu.

UsePackage UsePackage UsePackage UsePackage UsePackage

Gets or sets whether the product installation uses the package ID.

UseVsProductId UseVsProductId UseVsProductId UseVsProductId UseVsProductId

Determines whether the product ID is the same as the Visual Studio ID.

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)

Registers information about a VSPackage when called by an external registration tool such as regpkg.exe.

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

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe.

Applies to