AsyncCompletedEventArgs Klasse

  • Referenz

Definition

Namespace:
System.ComponentModel
Assembly:
System.ComponentModel.EventBasedAsync.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Quelle:
AsyncCompletedEvent.cs
Quelle:
AsyncCompletedEvent.cs
Quelle:
AsyncCompletedEvent.cs

Stellt Daten für das MethodNameCompleted-Ereignis bereit.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Vererbung
Object
EventArgs
AsyncCompletedEventArgs
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die AsyncOperation Lebensdauer asynchroner Vorgänge nachverfolgt wird. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die System.ComponentModel.AsyncOperationManager-Klasse bereitgestellt wird.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Threading;
using System.Windows.Forms;

Imports System.Collections
Imports System.Collections.Specialized
Imports System.ComponentModel
Imports System.Drawing
Imports System.Globalization
Imports System.Threading
Imports System.Windows.Forms

// This event handler updates the ListView control when the
// PrimeNumberCalculator raises the CalculatePrimeCompleted
// event. The ListView item is updated with the appropriate
// outcome of the calculation: Canceled, Error, or result.
private void primeNumberCalculator1_CalculatePrimeCompleted(
    object sender, 
    CalculatePrimeCompletedEventArgs e)
{
    Guid taskId = (Guid)e.UserState;

    if (e.Cancelled)
    {   
        string result = "Canceled";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Pink;
            lvi.Tag = null;
        }
    }
    else if (e.Error != null)
    {
        string result = "Error";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Red;
            lvi.ForeColor = Color.White;
            lvi.Tag = null;
        }
    }
    else
    {   
        bool result = e.IsPrime;

        ListViewItem lvi = UpdateListViewItem(
            taskId, 
            result, 
            e.FirstDivisor);

        if (lvi != null)
        {
            lvi.BackColor = Color.LightGray;
            lvi.Tag = null;
        }
    }
}

' This event handler updates the ListView control when the
' PrimeNumberCalculator raises the CalculatePrimeCompleted
' event. The ListView item is updated with the appropriate
' outcome of the calculation: Canceled, Error, or result.
Private Sub primeNumberCalculator1_CalculatePrimeCompleted( _
    ByVal sender As Object, _
    ByVal e As CalculatePrimeCompletedEventArgs) _
    Handles primeNumberCalculator1.CalculatePrimeCompleted

    Dim taskId As Guid = CType(e.UserState, Guid)

    If e.Cancelled Then
        Dim result As String = "Canceled"

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, _
            result)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.Pink
            lvi.Tag = Nothing
        End If

    ElseIf e.Error IsNot Nothing Then

        Dim result As String = "Error"

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, result)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.Red
            lvi.ForeColor = Color.White
            lvi.Tag = Nothing
        End If
    Else
        Dim result As Boolean = e.IsPrime

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, _
            result, _
            e.FirstDivisor)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.LightGray
            lvi.Tag = Nothing
        End If
    End If

End Sub

Hinweise

Wenn Sie eine Klasse verwenden, die die Ereignisbasierte asynchrone Musterübersicht implementiert, stellt die Klasse ein MethodName-EreignisCompleted bereit. Wenn Sie dem Ereignis eine instance des System.ComponentModel.AsyncCompletedEventHandler Delegaten hinzufügen, erhalten Sie Informationen über das Ergebnis asynchroner Vorgänge im Parameter der AsyncCompletedEventArgs entsprechenden Ereignishandlermethode.

Der Ereignishandlerdelegat der Clientanwendung kann die Cancelled Eigenschaft überprüfen, um festzustellen, ob die asynchrone Aufgabe abgebrochen wurde.

Der Ereignishandlerdelegat der Clientanwendung kann die Error Eigenschaft überprüfen, um zu ermitteln, ob während der Ausführung des asynchronen Tasks eine Ausnahme aufgetreten ist.

Wenn die -Klasse mehrere asynchrone Methoden oder mehrere Aufrufe derselben asynchronen Methode unterstützt, können Sie ermitteln, welche Aufgabe das MethodName-EreignisCompleted ausgelöst hat, indem Sie den Wert der UserState -Eigenschaft überprüfen. Ihr Code muss diese Token, die als Aufgaben-IDs bezeichnet werden, nachverfolgen, wenn die entsprechenden asynchronen Aufgaben gestartet und abgeschlossen werden.

Hinweise für Vererber

Klassen, die dem ereignisbasierten asynchronen Muster folgen, können Ereignisse auslösen, um Clients über die status ausstehender asynchroner Vorgänge zu warnen. Wenn die -Klasse ein MethodName-EreignisCompleted bereitstellt, können Sie die AsyncCompletedEventArgs Clients über das Ergebnis asynchroner Vorgänge informieren.

Möglicherweise möchten Sie Clients mehr Informationen über das Ergebnis eines asynchronen Vorgangs als einen AsyncCompletedEventArgs -Vorgang mitteilen. In diesem Fall können Sie Ihre eigene Klasse von der AsyncCompletedEventArgs -Klasse ableiten und zusätzliche private instance Variablen und entsprechende schreibgeschützte öffentliche Eigenschaften bereitstellen. Rufen Sie die RaiseExceptionIfNecessary() -Methode auf, bevor Sie den Eigenschaftswert zurückgeben, falls der Vorgang abgebrochen wurde oder ein Fehler aufgetreten ist.

Konstruktoren

AsyncCompletedEventArgs()
Veraltet.

Initialisiert eine neue Instanz der AsyncCompletedEventArgs-Klasse.
AsyncCompletedEventArgs(Exception, Boolean, Object)

Initialisiert eine neue Instanz der AsyncCompletedEventArgs-Klasse.

Eigenschaften

Cancelled

Ruft einen Wert ab, der angibt, ob ein asynchroner Vorgang abgebrochen wurde.
Error

Ruft einen Wert ab, der angibt, welcher Fehler während eines asynchronen Vorgangs aufgetreten ist.
UserState

Ruft den eindeutigen Bezeichner der asynchronen Aufgabe ab.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
RaiseExceptionIfNecessary()

Löst eine benutzerdefinierte Ausnahme aus, wenn bei einem asynchronen Vorgang ein Fehler aufgetreten ist.
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Gilt für:

Weitere Informationen