Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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
)

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 override void OnBeforeInstall(IDictionary savedState)
{
   base.OnBeforeInstall(savedState);
   // Add steps to be done before the installation starts.
   Console.WriteLine("OnBeforeInstall method of MyInstaller called");
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft