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

InstallEventArgs Class

Provides data for the events: BeforeInstall, AfterInstall, Committing, Committed, BeforeRollback, AfterRollback, BeforeUninstall, AfterUninstall.

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

public class InstallEventArgs : EventArgs
public class InstallEventArgs extends EventArgs
public class InstallEventArgs extends EventArgs

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.

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


import System.*;
import System.ComponentModel.*;
import System.Collections.*;
import System.Configuration.Install.*;
import System.IO.*;

/** @attribute RunInstaller(true)
 */
public class MyInstaller extends Installer
{
    // Simple events to handle before and after commit handlers.
    public InstallEventHandler beforeCommit = null;
    public InstallEventHandler afterCommit = null;


    /** @event 
     */
    public void add_beforeCommitHandler(InstallEventHandler p)
    {
        beforeCommit = 
            (InstallEventHandler)System.Delegate.Combine(beforeCommit, p);
    

    /** @event 
     */
    public void remove_beforeCommitHandler(InstallEventHandler p)
    {
        beforeCommit = 
            (InstallEventHandler)System.Delegate.Remove(beforeCommit, p);
    

    /** @event 
     */
    public void add_afterCommitHandler(InstallEventHandler p)
    {
        afterCommit = 
            (InstallEventHandler)System.Delegate.Combine(afterCommit, p);
    

    /** @event 
     */
    public void remove_afterCommitHandler(InstallEventHandler p)
    {
        afterCommit = 
            (InstallEventHandler)System.Delegate.Remove(afterCommit, p);
    

    public MyInstaller()
    {
        // Add handlers to the events.
        add_beforeCommitHandler(new InstallEventHandler(BeforeCommitHandler));
        add_afterCommitHandler(new InstallEventHandler(AfterCommitHandler));
     //MyInstaller

    public void Install(IDictionary savedState)
    {
        super.Install(savedState);
        Console.WriteLine("Install ...\n");
     //Install

    public void Commit(IDictionary savedState)
    {
        Console.WriteLine("Before Committing ...\n");

        // Call the 'OnBeforeCommit' protected method.
        OnBeforeCommit(savedState);
        super.Commit(savedState);
        Console.WriteLine("Committing ...\n");

        // Call the 'OnAfterCommit' protected method.
        OnAfterCommit(savedState);
        Console.WriteLine("After Committing ...\n");
     //Commit

    public void Rollback(IDictionary savedState)
    {
        super.Rollback(savedState);
        Console.WriteLine("RollBack ...\n");
     //Rollback

    public void Uninstall(IDictionary savedState)
    {
        super.Uninstall(savedState);
        Console.WriteLine("UnInstall ...\n");
     //Uninstall

    // Protected method that invoke the handlers associated 
    // with the 'BeforeCommit' event.
    protected void OnBeforeCommit(IDictionary savedState)
    {
        if (beforeCommit != null) {
            beforeCommit.Invoke(this, new InstallEventArgs(savedState));
        
     //OnBeforeCommit

    // Protected method that invoke the handlers associated 
    // with the 'AfterCommit' event.
    protected void OnAfterCommit(IDictionary savedState)
    {
        if (afterCommit != null) {
            afterCommit.Invoke(this, new InstallEventArgs());
        
     //OnAfterCommit

    // 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",
            System.Convert.ToString(e.get_SavedState().get_Count()));
     //BeforeCommitHandler

    // A simple event handler to exemplify the example.
    private void AfterCommitHandler(Object sender, InstallEventArgs e)
    {
        Console.WriteLine("AfterCommitHandler event handler has been called\n");
     //AfterCommitHandler
 //MyInstaller

System.Object
   System.EventArgs
    System.Configuration.Install.InstallEventArgs
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.