AsyncCompletedEventArgs Classe

Définition

public ref class AsyncCompletedEventArgs : EventArgs

public class AsyncCompletedEventArgs : EventArgs

type AsyncCompletedEventArgs = class
    inherit EventArgs

Public Class AsyncCompletedEventArgs
Inherits EventArgs

Héritage

Object

EventArgs

AsyncCompletedEventArgs

Dérivé

System.Activities.InvokeCompletedEventArgs

System.ComponentModel.RunWorkerCompletedEventArgs

System.Device.Location.ResolveAddressCompletedEventArgs

System.Net.DownloadDataCompletedEventArgs

System.Net.DownloadStringCompletedEventArgs

Plus…

Exemples

L’exemple de code suivant illustre l’utilisation d’un AsyncOperation modèle pour suivre la durée de vie des opérations asynchrones. Cet exemple de code fait partie d’un exemple plus grand fourni pour la System.ComponentModel.AsyncOperationManager classe.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
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.
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

Remarques

Si vous utilisez une classe qui implémente la vue d’ensemble du modèle asynchrone basé sur les événements, la classe fournit un événement MethodNameCompleted . Si vous ajoutez une instance du System.ComponentModel.AsyncCompletedEventHandler délégué à l’événement, vous recevrez des informations sur le résultat des opérations asynchrones dans le AsyncCompletedEventArgs paramètre de la méthode de gestionnaire d’événements correspondante.

Le délégué du gestionnaire d’événements de l’application cliente peut vérifier la Cancelled propriété pour déterminer si la tâche asynchrone a été annulée.

Le délégué du gestionnaire d’événements de l’application cliente peut vérifier la Error propriété pour déterminer si une exception s’est produite pendant l’exécution de la tâche asynchrone.

Si la classe prend en charge plusieurs méthodes asynchrones ou plusieurs appels à la même méthode asynchrone, vous pouvez déterminer quelle tâche a déclenché l’événement MethodNameCompleted en vérifiant la valeur de la UserState propriété. Votre code doit suivre ces jetons, appelés ID de tâche, car leurs tâches asynchrones correspondantes démarrent et se terminent.

Notes pour les héritiers

Les classes qui suivent le modèle asynchrone basé sur les événements peuvent déclencher des événements pour alerter les clients sur l’état des opérations asynchrones en attente. Si la classe fournit un événement MethodNameCompleted , vous pouvez utiliser le service pour indiquer aux AsyncCompletedEventArgs clients le résultat des opérations asynchrones.

Vous souhaiterez peut-être communiquer avec les clients plus d’informations sur le résultat d’une opération asynchrone qu’une AsyncCompletedEventArgs adaptation. Dans ce cas, vous pouvez dériver votre propre classe de la AsyncCompletedEventArgs classe et fournir des variables d’instance privées supplémentaires et des propriétés publiques en lecture seule correspondantes. Appelez la RaiseExceptionIfNecessary() méthode avant de retourner la valeur de la propriété, si l’opération a été annulée ou qu’une erreur s’est produite.

Voir aussi

• AsyncCompletedEventHandler
• AsyncOperationManager
• AsyncOperation
• Implémentation du modèle asynchrone basé sur les événements