Export (0) Print
Expand All

InstalledProductRegistrationAttribute Class

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.

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

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

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

The InstalledProductRegistrationAttribute type exposes the following members.

  NameDescription
Public methodInstalledProductRegistrationAttribute(String, String, String)Initializes a new instance of InstalledProductRegistrationAttribute with the specified product information.
Public methodInstalledProductRegistrationAttribute(Boolean, String, String, String) Obsolete. Initializes a new InstalledProductRegistrationAttribute instance for the specified product.
Public methodInstalledProductRegistrationAttribute(String, String, String, Boolean)Initializes a new instance of InstalledProductRegistrationAttribute the specified product details..
Top

  NameDescription
Public propertyIconResourceIDGets or sets the resource ID of the icon associated with the product.
Public propertyLanguageIndependentNameGets or sets the (non-localized) name of the product.
Public propertyProductDetailsGets or sets the detailed description of the product.
Public propertyProductDetailsResourceIDGets or sets the product details resource ID.
Public propertyProductIdGets or sets the product ID.
Public propertyProductNameGets or sets the name of the product.
Public propertyProductNameResourceIDGets or sets the resource ID of the product name.
Public propertyTypeIdGets the current instance of this attribute. (Inherited from RegistrationAttribute.)
Public propertyUseInterfaceGets 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.
Public propertyUsePackageGets or sets whether the product installation uses the package ID.
Public propertyUseVsProductIdDetermines whether the product ID is the same as the Visual Studio ID.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodRegisterRegisters information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnregisterRemoves the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves 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.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

NoteNote

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft