InstallEventArgs Class
Definition
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.
Provides data for the events: BeforeInstall, AfterInstall, Committing, Committed, BeforeRollback, AfterRollback, BeforeUninstall, AfterUninstall.
public ref class InstallEventArgs : EventArgs
public class InstallEventArgs : EventArgs
type InstallEventArgs = class
inherit EventArgs
Public Class InstallEventArgs
Inherits EventArgs
- Inheritance
Examples
The following example demonstrates the InstallEventArgs constructors and the SavedState property of the InstallEventArgs class.
There are two new events called BeforeCommit
and AfterCommit
. The handlers of these events are invoked from the protected methods named OnBeforeCommit
and OnAfterCommit
respectively. These events are raised when the Commit method is called.
#using <System.dll>
#using <System.Configuration.Install.dll>
using namespace System;
using namespace System::ComponentModel;
using namespace System::Collections;
using namespace System::Configuration::Install;
using namespace System::IO;
[RunInstaller(true)]
ref class MyInstaller: public Installer
{
public:
// Simple events to handle before and after commit handlers.
event InstallEventHandler^ BeforeCommit;
event InstallEventHandler^ AfterCommit;
MyInstaller()
{
// Add handlers to the events.
BeforeCommit += gcnew InstallEventHandler( this, &MyInstaller::BeforeCommitHandler );
AfterCommit += gcnew InstallEventHandler( this, &MyInstaller::AfterCommitHandler );
}
virtual void Install( IDictionary^ savedState ) override
{
Installer::Install( savedState );
Console::WriteLine( "Install ...\n" );
}
virtual void Commit( IDictionary^ savedState ) override
{
Console::WriteLine( "Before Committing ...\n" );
// Call the 'OnBeforeCommit' protected method.
OnBeforeCommit( savedState );
Installer::Commit( savedState );
Console::WriteLine( "Committing ...\n" );
// Call the 'OnAfterCommit' protected method.
OnAfterCommit( savedState );
Console::WriteLine( "After Committing ...\n" );
}
virtual void Rollback( IDictionary^ savedState ) override
{
Installer::Rollback( savedState );
Console::WriteLine( "RollBack ...\n" );
}
virtual void Uninstall( IDictionary^ savedState ) override
{
Installer::Uninstall( savedState );
Console::WriteLine( "UnInstall ...\n" );
}
// Protected method that invoke the handlers associated with the 'BeforeCommit' event.
protected:
virtual void OnBeforeCommit( IDictionary^ savedState )
{
BeforeCommit( this, gcnew InstallEventArgs( savedState ) );
}
// Protected method that invoke the handlers associated with the 'AfterCommit' event.
protected:
virtual void OnAfterCommit( IDictionary^ savedState )
{
AfterCommit( this, gcnew InstallEventArgs );
}
// A simple event handler to exemplify the example.
void BeforeCommitHandler( Object^ sender, InstallEventArgs^ e )
{
Console::WriteLine( "BeforeCommitHandler event handler has been called\n" );
Console::WriteLine( "The count of saved state objects are : {0}\n",
e->SavedState->Count );
}
// A simple event handler to exemplify the example.
private:
void AfterCommitHandler( Object^ sender, InstallEventArgs^ e )
{
Console::WriteLine( "AfterCommitHandler event handler has been called\n" );
}
};
using System;
using System.ComponentModel;
using System.Collections;
using System.Configuration.Install;
using System.IO;
[RunInstaller(true)]
public class MyInstaller : Installer
{
// Simple events to handle before and after commit handlers.
public event InstallEventHandler BeforeCommit;
public event InstallEventHandler AfterCommit;
public MyInstaller()
{
// Add handlers to the events.
BeforeCommit += new InstallEventHandler(BeforeCommitHandler);
AfterCommit += new InstallEventHandler(AfterCommitHandler);
}
public override void Install(IDictionary savedState)
{
base.Install(savedState);
Console.WriteLine("Install ...\n");
}
public override void Commit(IDictionary savedState)
{
Console.WriteLine("Before Committing ...\n");
// Call the 'OnBeforeCommit' protected method.
OnBeforeCommit(savedState);
base.Commit(savedState);
Console.WriteLine("Committing ...\n");
// Call the 'OnAfterCommit' protected method.
OnAfterCommit(savedState);
Console.WriteLine("After Committing ...\n");
}
public override void Rollback(IDictionary savedState)
{
base.Rollback(savedState);
Console.WriteLine("RollBack ...\n");
}
public override void Uninstall(IDictionary savedState)
{
base.Uninstall(savedState);
Console.WriteLine("UnInstall ...\n");
}
// Protected method that invoke the handlers associated with the 'BeforeCommit' event.
protected virtual void OnBeforeCommit(IDictionary savedState)
{
if(BeforeCommit != null)
BeforeCommit(this, new InstallEventArgs(savedState));
}
// Protected method that invoke the handlers associated with the 'AfterCommit' event.
protected virtual void OnAfterCommit(IDictionary savedState)
{
if(AfterCommit != null)
AfterCommit(this, new InstallEventArgs());
}
// A simple event handler to exemplify the example.
private void BeforeCommitHandler(Object sender, InstallEventArgs e)
{
Console.WriteLine("BeforeCommitHandler event handler has been called\n");
Console.WriteLine("The count of saved state objects are : {0}\n",
e.SavedState.Count);
}
// A simple event handler to exemplify the example.
private void AfterCommitHandler(Object sender, InstallEventArgs e)
{
Console.WriteLine("AfterCommitHandler event handler has been called\n");
}
}
Imports System.ComponentModel
Imports System.Collections
Imports System.Configuration.Install
Imports System.IO
<RunInstaller(True)> Public Class MyInstaller
Inherits Installer
' Simple events to handle before and after commit handlers.
Public Event BeforeCommit As InstallEventHandler
Public Event AfterCommit As InstallEventHandler
Public Sub New()
' Add handlers to the events.
AddHandler BeforeCommit, AddressOf BeforeCommitHandler
AddHandler AfterCommit, AddressOf AfterCommitHandler
End Sub
Public Overrides Sub Install(savedState As IDictionary)
MyBase.Install(savedState)
Console.WriteLine("Install ..." + ControlChars.Newline)
End Sub
Public Overrides Sub Commit(savedState As IDictionary)
Console.WriteLine("Before Committing ..." + ControlChars.Newline)
' Call the 'OnBeforeCommit' protected method.
OnBeforeCommit(savedState)
MyBase.Commit(savedState)
Console.WriteLine("Committing ..." + ControlChars.Newline)
' Call the 'OnAfterCommit' protected method.
OnAfterCommit(savedState)
Console.WriteLine("After Committing ..." + ControlChars.Newline)
End Sub
Public Overrides Sub Rollback(savedState As IDictionary)
MyBase.Rollback(savedState)
Console.WriteLine("RollBack ..." + ControlChars.Newline)
End Sub
Public Overrides Sub Uninstall(savedState As IDictionary)
MyBase.Uninstall(savedState)
Console.WriteLine("UnInstall ..." + ControlChars.Newline)
End Sub
' Protected method that invoke the handlers associated with the 'BeforeCommit' event.
Protected Overridable Sub OnBeforeCommit(savedState As IDictionary)
RaiseEvent BeforeCommit(Me, New InstallEventArgs(savedState))
End Sub
' Protected method that invoke the handlers associated with the 'AfterCommit' event.
Protected Overridable Sub OnAfterCommit(savedState As IDictionary)
RaiseEvent AfterCommit(Me, New InstallEventArgs())
End Sub
' A simple event handler to exemplify the example.
Private Sub BeforeCommitHandler(sender As Object, e As InstallEventArgs)
Console.WriteLine("BeforeCommitHandler event handler has been called" + _
ControlChars.Newline)
Console.WriteLine("The count of saved state objects are : {0}" + _
ControlChars.Newline, e.SavedState.Count)
End Sub
' A simple event handler to exemplify the example.
Private Sub AfterCommitHandler(sender As Object, e As InstallEventArgs)
Console.WriteLine("AfterCommitHandler event handler has been called" + _
ControlChars.Newline)
End Sub
End Class
Remarks
InstallEventArgs contains an IDictionary that holds information about the current state of the installation. The BeforeInstall, AfterInstall, Committing, Committed, BeforeRollback, AfterRollback, BeforeUninstall, and AfterUninstall event handlers use this information.
Constructors
InstallEventArgs() |
Initializes a new instance of the InstallEventArgs class, and leaves the SavedState property empty. |
InstallEventArgs(IDictionary) |
Initializes a new instance of the InstallEventArgs class, and specifies the value for the SavedState property. |
Properties
SavedState |
Gets an IDictionary that represents the current state of the installation. |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |