Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ComponentInstaller Class

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies an installer that copies properties from a component to use at install time.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Configuration.Install.Installer
        System.Configuration.Install.ComponentInstaller
          System.Diagnostics.EventLogInstaller
          System.Diagnostics.PerformanceCounterInstaller
          System.Messaging.MessageQueueInstaller
          System.ServiceProcess.ServiceInstaller
          System.ServiceProcess.ServiceProcessInstaller

Namespace:  System.Configuration.Install
Assembly:  System.Configuration.Install (in System.Configuration.Install.dll)
C#
C++
F#
VB
Copy 
public abstract class ComponentInstaller : Installer

The ComponentInstaller type exposes the following members.

  Name Description
Protected method ComponentInstaller Initializes a new instance of the ComponentInstaller class.
Top
  Name Description
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property Context Gets or sets information about the current installation. (Inherited from Installer.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property HelpText Gets the help text for all the installers in the installer collection. (Inherited from Installer.)
Public property Installers Gets the collection of installers that this installer contains. (Inherited from Installer.)
Public property Parent Gets or sets the installer containing the collection that this installer belongs to. (Inherited from Installer.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Top
  Name Description
Public method Commit When overridden in a derived class, completes the install transaction. (Inherited from Installer.)
Public method CopyFromComponent When overridden in a derived class, copies all the properties that are required at install time from the specified component.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Install When overridden in a derived class, performs the installation. (Inherited from Installer.)
Public method IsEquivalentInstaller Determines if the specified installer installs the same object as this installer.
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnAfterInstall Raises the AfterInstall event. (Inherited from Installer.)
Protected method OnAfterRollback Raises the AfterRollback event. (Inherited from Installer.)
Protected method OnAfterUninstall Raises the AfterUninstall event. (Inherited from Installer.)
Protected method OnBeforeInstall Raises the BeforeInstall event. (Inherited from Installer.)
Protected method OnBeforeRollback Raises the BeforeRollback event. (Inherited from Installer.)
Protected method OnBeforeUninstall Raises the BeforeUninstall event. (Inherited from Installer.)
Protected method OnCommitted Raises the Committed event. (Inherited from Installer.)
Protected method OnCommitting Raises the Committing event. (Inherited from Installer.)
Public method Rollback When overridden in a derived class, restores the pre-installation state of the computer. (Inherited from Installer.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public method Uninstall When overridden in a derived class, removes an installation. (Inherited from Installer.)
Top
  Name Description
Public event AfterInstall Occurs after the Install methods of all the installers in the Installers property have run. (Inherited from Installer.)
Public event AfterRollback Occurs after the installations of all the installers in the Installers property are rolled back. (Inherited from Installer.)
Public event AfterUninstall Occurs after all the installers in the Installers property perform their uninstallation operations. (Inherited from Installer.)
Public event BeforeInstall Occurs before the Install method of each installer in the installer collection has run. (Inherited from Installer.)
Public event BeforeRollback Occurs before the installers in the Installers property are rolled back. (Inherited from Installer.)
Public event BeforeUninstall Occurs before the installers in the Installers property perform their uninstall operations. (Inherited from Installer.)
Public event Committed Occurs after all the installers in the Installers property have committed their installations. (Inherited from Installer.)
Public event Committing Occurs before the installers in the Installers property committ their installations. (Inherited from Installer.)
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

Notes to Inheritors

When you inherit from ComponentInstaller, you must override the CopyFromComponent method, and typically override the Install and Uninstall methods.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)