Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Installer.OnBeforeInstall Method

Raises the BeforeInstall event.

[Visual Basic]
Protected Overridable Sub OnBeforeInstall( _
   ByVal savedState As IDictionary _
)
[C#]
protected virtual void OnBeforeInstall(
 IDictionary savedState
);
[C++]
protected: virtual void OnBeforeInstall(
 IDictionary* savedState
);
[JScript]
protected function OnBeforeInstall(
   savedState : IDictionary
);

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.

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

The OnBeforeInstall method also 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.

Example

[Visual Basic, C#, C++] 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.

[Visual Basic] 
' 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 'OnBeforeInstall

[C#] 
// 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");
}

[C++] 
// Override the 'OnBeforeInstall' method.
void OnBeforeInstall(IDictionary* savedState) {
    Installer::OnBeforeInstall(savedState);
    // Add steps to be done before the installation starts.
    Console::WriteLine(S"OnBeforeInstall method of MyInstaller called");
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Installer Class | Installer Members | System.Configuration.Install Namespace | OnAfterInstall | OnAfterRollback | OnAfterUninstall | OnCommitting | OnCommitted | OnBeforeRollback | OnBeforeUninstall

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.