InstallEventArgs-Klasse

Stellt Daten für die Ereignisse BeforeInstall, AfterInstall, Committing, Committed, BeforeRollback, AfterRollback, BeforeUninstall und AfterUninstall bereit.

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

Syntax

'Declaration
Public Class InstallEventArgs
    Inherits EventArgs
'Usage
Dim instance As InstallEventArgs

public class InstallEventArgs : EventArgs

public ref class InstallEventArgs : public EventArgs

public class InstallEventArgs extends EventArgs

public class InstallEventArgs extends EventArgs

Hinweise

InstallEventArgs enthält ein IDictionary mit Informationen über den aktuellen Zustand der Installation. Diese Informationen werden von den Ereignishandlern BeforeInstall, AfterInstall, Committing, Committed, BeforeRollback, AfterRollback, BeforeUninstall und AfterUninstall verwendet.

Beispiel

Das folgende Beispiel veranschaulicht die InstallEventArgs-Konstruktoren und die SavedState-Eigenschaft der InstallEventArgs-Klasse.

Es werden die zwei neuen Ereignisse BeforeCommit und AfterCommit aufgeführt. Die Handler dieser Ereignisse werden von den geschützten Methoden OnBeforeCommit bzw. OnAfterCommit aufgerufen. Diese Ereignisse werden ausgelöst, wenn die Commit-Methode aufgerufen wird.

Imports System
Imports System.ComponentModel
Imports System.Collections
Imports System.Configuration.Install
Imports System.IO
Imports Microsoft.VisualBasic

<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

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

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

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

Vererbungshierarchie

System.Object
   System.EventArgs
    System.Configuration.Install.InstallEventArgs

Threadsicherheit

Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Plattformen

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

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

InstallEventArgs-Member
System.Configuration.Install-Namespace
Installer.AfterInstall-Ereignis
Installer.AfterRollback-Ereignis
Installer.AfterUninstall-Ereignis
Installer.BeforeInstall-Ereignis
Installer.BeforeRollback-Ereignis
Installer.BeforeUninstall-Ereignis
Commit
Installer.Committed-Ereignis
Installer.Committing-Ereignis
Install
Installer-Klasse
InstallEventHandler
Rollback
Uninstall