MsiComponentIdAttribute Class
Defines the Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the VSPackage.
Inheritance Hierarchy
Object
Attribute
Microsoft.VisualStudio.Shell.MsiComponentIdAttribute
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class MsiComponentIdAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class MsiComponentIdAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, Inherited = false)]
public ref class MsiComponentIdAttribute sealed : public Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)>]
type MsiComponentIdAttribute =
class
inherit Attribute
end
public final class MsiComponentIdAttribute extends Attribute
The MsiComponentIdAttribute type exposes the following members.
Constructors
Name | Description | |
---|---|---|
MsiComponentIdAttribute | This constructor creates a new MsiComponentIdAttribute object. |
Top
Properties
Name | Description | |
---|---|---|
Id | The Id property returns a string containing the Windows Installer component registration ID. | |
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Top
Methods
Name | Description | |
---|---|---|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) | |
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) | |
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.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
System#Runtime#InteropServices#_Attribute#GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Top
Remarks
When to Call
Apply this attribute to a Package-derived class or one that implements IVsPackage when you use the Windows Installer to install your VSPackage.
Basic Usage
MsiComponentIdAttribute defines the Microsoft Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the component.
This attribute class is only used 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 MsiComponentId.
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.
See Also
Reference
Microsoft.VisualStudio.Shell Namespace