Exemplarische Vorgehensweise: Behandeln von Ereignissen (Visual Basic)

Artikel
07/20/2011

In diesem Thema, dem zweiten von zwei verwandten Themen, wird die Arbeit mit Ereignissen veranschaulicht. Im ersten Thema (Exemplarische Vorgehensweise: Deklarieren und Auslösen von Ereignissen) wird beschrieben, wie Ereignisse deklariert und ausgelöst werden. In diesem Abschnitt werden das Formular und die Klasse aus der erwähnten exemplarischen Vorgehensweise verwendet, um zu demonstrieren, wie eingetretene Ereignisse behandelt werden.

Im Beispiel mit der Widget-Klasse werden herkömmliche Ereignisbehandlungsanweisungen verwendet. Visual Basic stellt andere Techniken zur Arbeit mit Ereignissen bereit. Um weitere praktische Erfahrungen zu gewinnen, können Sie dieses Beispiel für die Verwendung der AddHandler-Anweisung und der Handles-Anweisung abwandeln.

Fügen Sie in Form1 folgenden Code ein:
```
Private WithEvents mWidget As Widget
Private mblnCancel As Boolean
```
Das WithEvents-Schlüsselwort legt fest, dass die Variable mWidget zur Behandlung von Objektereignissen verwendet wird. Sie legen den Objekttyp fest, indem Sie den Namen der Klasse angeben, aus der das Objekt erstellt wird.

Die Variable mWidget wird in Form1 deklariert, da WithEvents-Variablen auf Klassenebene definiert werden müssen. Dies gilt unabhängig vom Typ der Klasse, in die sie eingefügt werden.

Die mblnCancel-Variable wird verwendet, um die LongTask-Methode abzubrechen.

Schreiben von Code zur Ereignisbehandlung

Sobald Sie ein eVariable mit WithEvents deklarieren, wird der Variablenname in der linken Dropdownliste des Code-Editors der Klasse angezeigt. Wenn Sie mWidget auswählen, werden die Ereignisse der Widget-Klasse in der rechten Dropdownliste angezeigt. Bei Auswahl eines Ereignisses wird die entsprechende Ereignisprozedur mit dem Präfix mWidget und einem Unterstrich angezeigt. Alle mit einer WithEvents-Variablen verknüpften Ereignisprozeduren erhalten als Präfix den Variablennamen.

So behandeln Sie ein Ereignis

Wählen Sie mWidget in der linken Dropdownliste des Code-Editors aus.
Wählen Sie das PercentDone-Ereignis aus der rechten Dropdownliste aus. Der Code-Editor öffnet die mWidget_PercentDone-Ereignisprozedur.

Tipp

Zum Einfügen neuer Ereignishandler ist der Code-Editor hilfreich, doch nicht erforderlich. In dieser exemplarischen Vorgehensweise werden die Ereignishandler einfach direkt in den Code eingefügt.
Fügen Sie dem mWidget_PercentDone-Ereignishandler folgenden Code hinzu:
```
Private Sub mWidget_PercentDone( 
    ByVal Percent As Single, 
    ByRef Cancel As Boolean 
) Handles mWidget.PercentDone
    lblPercentDone.Text = CInt(100 * Percent) & "%"
    My.Application.DoEvents()
    If mblnCancel Then Cancel = True
End Sub
```
Bei jedem Auslösen des PercentDone-Ereignisses zeigt die Ereignisprozedur den Prozentsatz der bereits erfolgten Verarbeitung in einem Label-Steuerelement an. Die DoEvents-Methode bietet nicht nur die Möglichkeit, die Bezeichnung neu zu zeichnen, sondern ermöglicht es darüber hinaus dem Benutzer, auf die Schaltfläche Abbrechen zu klicken.

Fügen Sie folgenden Code für den Button2_Click-Ereignishandler hinzu:

Private Sub Button2_Click( 
    ByVal sender As Object, 
    ByVal e As System.EventArgs 
) Handles Button2.Click
    mblnCancel = True
End Sub

Wenn der Benutzer während der Ausführung von LongTask auf die Schaltfläche Abbrechen klickt, wird das Button2_Click-Ereignis ausgeführt, sobald die DoEvents-Anweisung die Ereignisverarbeitung zulässt. Die Variable mblnCancel auf Klassenebene wird auf True festgelegt und anschließend vom mWidget_PercentDone-Ereignis überprüft, und das ByRef Cancel-Argument wird auf True festgelegt.

Verbinden einer WithEvents-Variablen mit einem Objekt

Form1 ist jetzt für die Behandlung von Ereignissen eines Widget-Objekts eingerichtet. Jetzt muss nur noch ein Widget-Objekt gefunden werden.

Wenn Sie eine WithEvents-Variable zur Entwurfszeit deklarieren, wird kein Objekt damit verknüpft. Eine WithEvents-Variable funktioniert genau wie jede andere Objektvariable. Sie müssen ein Objekt erstellen und ihm mithilfe der WithEvents-Variablen einen Verweis zuweisen.

So erstellen Sie ein Objekt und weisen ihm einen Verweis zu

Wählen Sie (Form1-Ereignisse) in der linken Dropdownliste des Code-Editors aus.
Wählen Sie das Load-Ereignis aus der rechten Dropdownliste aus. Der Code-Editor öffnet die Form1_Load-Ereignisprozedur.

Fügen Sie folgenden Code für die Form1_Load-Ereignisprozedur hinzu, um das Widget zu erstellen:

Private Sub Form1_Load( 
    ByVal sender As System.Object, 
    ByVal e As System.EventArgs 
) Handles MyBase.Load
    mWidget = New Widget
End Sub

Wenn dieser Code ausgeführt wird, erstellt Visual Basic ein Widget-Objekt und verbindet die zugehörigen Ereignisse mit den Ereignisprozeduren, die mWidget zugeordnet sind. Von diesem Zeitpunkt an wird die mWidget_PercentDone-Ereignisprozedur immer ausgeführt, wenn das PercentDone-Ereignis vom Widget ausgelöst wird.

So rufen Sie die LongTask-Methode auf

Fügen Sie dem Button1_Click-Ereignishandler folgenden Code hinzu:

Private Sub Button1_Click( 
    ByVal sender As Object, 
    ByVal e As System.EventArgs 
) Handles Button1.Click
    mblnCancel = False
    lblPercentDone.Text = "0%"
    lblPercentDone.Refresh()
    mWidget.LongTask(12.2, 0.33)
    If Not mblnCancel Then lblPercentDone.Text = CStr(100) & "%"
End Sub

Bevor die LongTask-Methode aufgerufen wird, muss die Bezeichnung initialisiert werden, die den Prozentsatz der bereits erfolgten Verarbeitung anzeigt. Außerdem muss das auf Klassenebene deklarierte Boolean-Flag zum Abbrechen der Methode auf False festgelegt werden.

LongTask wird mit einer Aufgabendauer von 12,2 Sekunden aufgerufen. Das PercentDone-Ereignis wird jede Drittelsekunde einmal ausgelöst. Bei jedem Auslösen des Ereignisses wird die mWidget_PercentDone-Ereignisprozedur ausgeführt.

Nachdem LongTask abgeschlossen wurde, wird mblnCancel daraufhin überprüft, ob LongTask normal beendet oder angehalten wurde, weil mblnCancel auf True festgelegt war. Der bereits verarbeitete Prozentsatz wird nur im ersten Fall aktualisiert.

So führen Sie das Programm aus

Drücken Sie F5, um das Projekt auszuführen.
Klicken Sie auf die Schaltfläche Start Task. Jedes Mal, wenn das PercentDone-Ereignis ausgelöst wird, wird die Bezeichnung mit dem Prozentsatz der Aufgabe, der bereits erledigt wurde, aktualisiert.
Klicken Sie auf die Cancel-Schaltfläche, um die Aufgabe abzubrechen. Beachten Sie, dass sich das Erscheinungsbild der Cancel-Schaltfläche nicht direkt ändert, wenn Sie darauf klicken. Das Click-Ereignis kann erst eintreten, wenn die My.Application.DoEvents-Anweisung die Ereignisverarbeitung zulässt.

Tipp

Die My.Application.DoEvents-Methode verarbeitet Ereignisse nicht genau auf die gleiche Weise wie das Formular. In dieser exemplarischen Vorgehensweise müssen Sie z. B. zweimal auf die Schaltfläche Abbrechen klicken. Damit das Formular die Ereignisse direkt behandeln kann, können Sie Multithreading verwenden. Weitere Informationen finden Sie unter Threading (C# und Visual Basic).

Möglicherweise finden Sie es aufschlussreich, das Programm durch Drücken von F11 auszuführen und den Code zeilenweise durchzugehen. In diesem Fall ist klar erkennbar, wie die Ausführung von LongTask beginnt und bei jedem Auslösen des PercentDone-Ereignisses kurz wieder zu Form1 zurückkehrt.

Was geschieht jedoch, wenn sich die Ausführungsroutine wieder im Code von Form1 befindet, während die LongTask-Methode erneut aufgerufen wird? Wenn LongTask bei jedem Auslösen des Ereignisses aufgerufen würde, wäre im schlimmsten Fall ein Stapelüberlauf die Folge.

Sie können festlegen, dass die Variable mWidget Ereignisse für ein anderes Widget-Objekt behandelt, indem Sie mWidget einen Verweis auf das neue Widget zuweisen. Der Code in Button1_Click kann diesen Vorgang sogar jedes Mal ausführen, wenn Sie auf die Schaltfläche klicken.

Fügen Sie der Button1_Click-Prozedur die folgende Codezeile direkt vor der Zeile mWidget.LongTask(12.2, 0.33) hinzu:
```
mWidget = New Widget
' Create a new Widget object.
```

Durch den oben stehenden Code wird bei jedem Klicken auf die Schaltfläche ein neues Widget erstellt. Bei Abschluss der LongTask-Methode wird der Verweis auf das Widget freigegeben und das Widget zerstört.

Eine WithEvents-Variable kann jeweils nur einen Objektverweis enthalten. Wenn Sie mWidget ein anderes Widget-Objekt zuweisen, werden daher die Ereignisse des vorherigen Widget-Objekts nicht mehr behandelt. Wenn mWidget als einzige Objektvariable einen Verweis auf das alte Widget enthält, wird das Objekt zerstört. Wenn die Ereignisse mehrerer Widget-Objekte behandelt werden sollen, verwenden Sie die AddHandler-Anweisung, um die Ereignisse der einzelnen Objekte gesondert zu verarbeiten.

Tipp

Sie können beliebig viele WithEvents-Variablen deklarieren, Arrays von WithEvents-Variablen werden jedoch nicht unterstützt.

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Deklarieren und Auslösen von Ereignissen (Visual Basic)

Weitere Ressourcen

Ereignisse (Visual Basic)

Freigeben über