Installer.OnBeforeInstall(IDictionary) Method

Reference

Definition

Namespace:: System.Configuration.Install

Assembly:: System.Configuration.Install.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the BeforeInstall event.

protected:
 virtual void OnBeforeInstall(System::Collections::IDictionary ^ savedState);

protected virtual void OnBeforeInstall (System.Collections.IDictionary savedState);

abstract member OnBeforeInstall : System.Collections.IDictionary -> unit
override this.OnBeforeInstall : System.Collections.IDictionary -> unit

Protected Overridable Sub OnBeforeInstall (savedState As IDictionary)

Parameters

savedState: 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.

Examples

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" );
   }

// Override the 'OnBeforeInstall' method.
protected override void OnBeforeInstall(IDictionary savedState)
{
   base.OnBeforeInstall(savedState);
   // Add steps to be done before the installation starts.
   Console.WriteLine("OnBeforeInstall method of MyInstaller called");
}

' Override the 'OnBeforeInstall' method.
Protected Overrides Sub OnBeforeInstall(savedState As IDictionary)
   MyBase.OnBeforeInstall(savedState)
   ' Add steps to be done before the installation starts.
   Console.WriteLine("OnBeforeInstall method of MyInstaller called")
End Sub

Remarks

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(IDictionary) in a derived class, be sure to call the base class's OnBeforeInstall(IDictionary) method so that registered delegates receive the event.

Applies to

Partajați prin