Installer::OnBeforeInstall Method (IDictionary^)

 
System_CAPS_noteNote

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

Raises the BeforeInstall event.

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

protected:
virtual void OnBeforeInstall(
	IDictionary^ savedState
)

Parameters

savedState
Type: System.Collections::IDictionary^

An IDictionary that contains the state of the computer before the installers in the Installers property are installed. This IDictionary object should be empty at this point.

This method is called before the Install methods of the installers in this instance's InstallerCollection are called.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnBeforeInstall method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnBeforeInstall in a derived class, be sure to call the base class's OnBeforeInstall method so that registered delegates receive the event.

The following example demonstrates the OnBeforeInstall method. This method is overridden in the derived class. Space is provided to add steps to be done before the installation in the OnBeforeInstall method.

   // Override the 'OnBeforeInstall' method.
protected:
   virtual void OnBeforeInstall( IDictionary^ savedState ) override
   {
      Installer::OnBeforeInstall( savedState );

      // Add steps to be done before the installation starts.
      Console::WriteLine( "OnBeforeInstall method of MyInstaller called" );
   }

.NET Framework
Available since 1.1
Return to top
Show: