Installer Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides the foundation for custom installations.

Namespace:   System.Configuration.Install
Assembly:  System.Configuration.Install (in System.Configuration.Install.dll)

type Installer = 
        inherit Component


Initializes a new instance of the Installer class.


Gets a value indicating whether the component can raise an event.(Inherited from Component.)


Gets the IContainer that contains the Component.(Inherited from Component.)


Gets or sets information about the current installation.


Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)


Gets the list of event handlers that are attached to this Component.(Inherited from Component.)


Gets the help text for all the installers in the installer collection.


Gets the collection of installers that this installer contains.


Gets or sets the installer containing the collection that this installer belongs to.


Gets or sets the ISite of the Component.(Inherited from Component.)


When overridden in a derived class, completes the install transaction.


Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)


Releases all resources used by the Component.(Inherited from Component.)


Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)


Serves as the default hash function. (Inherited from Object.)


Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)


Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)


Gets the Type of the current instance.(Inherited from Object.)


Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)


When overridden in a derived class, performs the installation.


Creates a shallow copy of the current Object.(Inherited from Object.)


Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)


Raises the AfterInstall event.


Raises the AfterRollback event.


Raises the AfterUninstall event.


Raises the BeforeInstall event.


Raises the BeforeRollback event.


Raises the BeforeUninstall event.


Raises the Committed event.


Raises the Committing event.


When overridden in a derived class, restores the pre-installation state of the computer.


Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)


When overridden in a derived class, removes an installation.


Occurs after the Install methods of all the installers in the Installers property have run.


Occurs after the installations of all the installers in the Installers property are rolled back.


Occurs after all the installers in the Installers property perform their uninstallation operations.


Occurs before the Install method of each installer in the installer collection has run.


Occurs before the installers in the Installers property are rolled back.


Occurs before the installers in the Installers property perform their uninstall operations.


Occurs after all the installers in the Installers property have committed their installations.


Occurs before the installers in the Installers property committ their installations.


Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

This is the base class for all custom installers in the .NET Framework. Installers are components that help install applications on a computer.

There are several steps you must follow to use an Installer:

  • Inherit the Installer class.

  • Override the Install, Commit, Rollback, and Uninstall methods.

  • Add the RunInstallerAttribute to your derived class and set it to true.

  • Put your derived class in the assembly with your application to install.

  • Invoke the installers. For example, use the InstallUtil.exe to invoke the installers.

The Installers property contains a collection of installers. If this instance of Installer is part of an installer collection, the Parent property is set to the Installer instance that contains the collection. For an example of the use of the Installers collection, see the AssemblyInstaller class.

The Install, Commit, Rollback, and Uninstall methods of the Installer class go through the collection of installers stored in the Installers property, and invokes the corresponding method of each installer.

The Install, Commit, Rollback, and Uninstall methods are not always called on the same Installer instance. For example, one Installer instance might be used while installing and committing an application, and then the reference to that instance is released. Later, uninstalling the application creates a reference to a new Installer instance, meaning that the Uninstall method is called by a different instance of Installer. For this reason, in your derived class, do not save the state of a computer in an installer. Instead, use an IDictionary that is preserved across calls and passed into your Install, Commit, Rollback, and Uninstall methods.

Two situations illustrate the need to save information in the state-saver IDictionary. First, suppose that your installer sets a registry key. It should save the key's original value in the IDictionary. If the installation is rolled back, the original value can be restored. Second, suppose the installer replaces an existing file. Save the existing file in a temporary directory and the location of the new location of the file in the IDictionary. If the installation is rolled back, the newer file is deleted and replaced by the original from the temporary location.

The Installer.Context property contains information about the installation. For example, information about the location of the log file for the installation, the location of the file to save information required by the Uninstall method, and the command line that was entered when the installation executable was run.

The following example demonstrates the use of the Installer class. It creates a class which inherits from Installer. When Commit is about to complete, Committing event occurs and a message is displayed. To use the Installer class, you must reference the System.Configuration.Install assembly in your project.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

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

Return to top