Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Installer.OnBeforeInstall Method

Raises the BeforeInstall event.

Namespace: System.Configuration.Install
Assembly: System.Configuration.Install (in system.configuration.install.dll)

protected virtual void OnBeforeInstall (
	IDictionary savedState
)
protected void OnBeforeInstall (
	IDictionary savedState
)
protected function OnBeforeInstall (
	savedState : IDictionary
)
Not applicable.

Parameters

savedState

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 Raising an Event.

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 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 void OnBeforeInstall(IDictionary savedState)
{
    super.OnBeforeInstall(savedState);

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft