.NET Framework Class Library
RunInstallerAttribute Class

Specifies whether the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should be invoked when the assembly is installed.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelRunInstallerAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_0_0_1%].Class)> _
Public Class RunInstallerAttribute _
	Inherits [%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_0_0_2%]
[[%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_1_0_1%].Class)]
public class RunInstallerAttribute : [%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_1_0_2%]
[[%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_2_0_1%]::Class)]
public ref class RunInstallerAttribute : public [%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_2_0_2%]
[<[%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_3_0_0%]([%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_3_0_1%].Class)>]
type RunInstallerAttribute =  
    class 
        inherit [%$TOPIC/2ya9dxy9_en-us_VS_110_3_0_3_0_2%] 
    end

The RunInstallerAttribute type exposes the following members.

Constructors
  NameDescription
Public method RunInstallerAttributeInitializes a new instance of the RunInstallerAttribute class.
Top
Properties
  NameDescription
Public property RunInstallerGets a value indicating whether an installer should be invoked during installation of an assembly.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsDetermines whether the value of the specified RunInstallerAttribute is equivalent to the current RunInstallerAttribute. (Overrides AttributeEquals(Object).)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCodeGenerates a hash code for the current RunInstallerAttribute. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines if this attribute is the default. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default visiblity, which is No. This static field is read-only.
Public field Static member NoSpecifies that the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should not be invoked when the assembly is installed. This static field is read-only.
Public field Static member YesSpecifies that the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should be invoked when the assembly is installed. This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

If a class that inherits from Installer is marked with the RunInstallerAttribute set to true, Visual Studio's Custom Action Installer or the InstallUtil.exe will be invoked when the assembly is installed. Members marked with the RunInstallerAttribute set to false will not invoke an installer. The default is true.

NoteNote

When you mark a property with the RunInstallerAttribute set to true, the value of this attribute is set to the constant member Yes. For a property marked with the RunInstallerAttribute set to false, the value is No. Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as RunInstallerAttributeYes or RunInstallerAttributeNo.

For more information, see Extending Metadata Using Attributes.

Examples

The following example specifies that the installer should be run for MyProjectInstaller.

<RunInstallerAttribute(True)> _
Public Class MyProjectInstaller
    Inherits Installer

    ' Insert code here. 
End Class 'MyProjectInstaller
[RunInstallerAttribute(true)]
 public class MyProjectInstaller : Installer {
    // Insert code here.
 }
[RunInstallerAttribute(true)]
ref class MyProjectInstaller: public Installer{
   // Insert code here.
};

The next example creates an instance of MyProjectInstaller. Then it gets the attributes for the class, extracts the RunInstallerAttribute, and prints whether to run the installer.

Public Shared Function Main() As Integer 
    ' Creates a new installer. 
    Dim myNewProjectInstaller As New MyProjectInstaller()

    ' Gets the attributes for the collection. 
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewProjectInstaller)

    ' Prints whether to run the installer by retrieving the 
    ' RunInstallerAttribute from the AttributeCollection.  
    Dim myAttribute As RunInstallerAttribute = _
        CType(attributes(GetType(RunInstallerAttribute)), RunInstallerAttribute)

    Console.WriteLine(("Run the installer? " & myAttribute.RunInstaller.ToString()))
    Return 0
End Function 'Main
public static int Main() {
    // Creates a new installer.
    MyProjectInstaller myNewProjectInstaller = new MyProjectInstaller();

    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewProjectInstaller);

    /* Prints whether to run the installer by retrieving the 
     * RunInstallerAttribute from the AttributeCollection. */
    RunInstallerAttribute myAttribute = 
       (RunInstallerAttribute)attributes[typeof(RunInstallerAttribute)];
    Console.WriteLine("Run the installer? " + myAttribute.RunInstaller.ToString());

    return 0;
 }
int main()
{
   // Creates a new installer.
   MyProjectInstaller^ myNewProjectInstaller = gcnew MyProjectInstaller;

   // Gets the attributes for the collection.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewProjectInstaller );

   /* Prints whether to run the installer by retrieving the 
       * RunInstallerAttribute from the AttributeCollection. */
   RunInstallerAttribute^ myAttribute = dynamic_cast<RunInstallerAttribute^>(attributes[ RunInstallerAttribute::typeid ]);
   Console::WriteLine( "Run the installer? {0}", myAttribute->RunInstaller );
   return 0;
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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.