AsyncCompletedEventArgs Klas

Definitie

public ref class AsyncCompletedEventArgs : EventArgs

public class AsyncCompletedEventArgs : EventArgs

type AsyncCompletedEventArgs = class
    inherit EventArgs

Public Class AsyncCompletedEventArgs
Inherits EventArgs

Overname

Object

EventArgs

AsyncCompletedEventArgs

Afgeleid

System.Activities.InvokeCompletedEventArgs

System.ComponentModel.RunWorkerCompletedEventArgs

System.Device.Location.ResolveAddressCompletedEventArgs

System.Net.DownloadDataCompletedEventArgs

System.Net.DownloadStringCompletedEventArgs

Meer…

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u een AsyncOperation voorbeeld gebruikt om de levensduur van asynchrone bewerkingen bij te houden. Dit codevoorbeeld maakt deel uit van een groter voorbeeld voor de System.ComponentModel.AsyncOperationManager klasse.

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

Opmerkingen

Als u een klasse gebruikt waarmee het Asynchrone patroonoverzicht op basis van gebeurtenissen wordt geïmplementeerd, biedt de klasse een MethodName-gebeurtenisCompleted . Als u een instantie van de System.ComponentModel.AsyncCompletedEventHandler gemachtigde aan de gebeurtenis toevoegt, ontvangt u informatie over het resultaat van asynchrone bewerkingen in de AsyncCompletedEventArgs parameter van de bijbehorende gebeurtenis-handlermethode.

De gemachtigde van de gebeurtenis-handler van de clienttoepassing kan de Cancelled eigenschap controleren om te bepalen of de asynchrone taak is geannuleerd.

De gemachtigde van de gebeurtenis-handler van de clienttoepassing kan de Error eigenschap controleren om te bepalen of er een uitzondering is opgetreden tijdens de uitvoering van de asynchrone taak.

Als de klasse ondersteuning biedt voor meerdere asynchrone methoden of meerdere aanroepen naar dezelfde asynchrone methode, kunt u bepalen welke taak de MethodName-gebeurtenisCompleted heeft gegenereerd door de waarde van de UserState eigenschap te controleren. Uw code moet deze tokens, ook wel taak-id's genoemd, bijhouden, omdat de bijbehorende asynchrone taken worden gestart en voltooid.

Notities voor overnemers

Klassen die het Asynchrone patroon op basis van gebeurtenissen volgen, kunnen gebeurtenissen genereren om clients te waarschuwen over de status van asynchrone bewerkingen die in behandeling zijn. Als de klasse een MethodName-gebeurtenisCompleted biedt, kunt u de AsyncCompletedEventArgs methode gebruiken om clients te informeren over het resultaat van asynchrone bewerkingen.

Mogelijk wilt u meer informatie over het resultaat van een asynchrone bewerking communiceren met clients dan geschikt is voor clients AsyncCompletedEventArgs . In dit geval kunt u uw eigen klasse afleiden uit de AsyncCompletedEventArgs klasse en aanvullende privé-exemplaarvariabelen en bijbehorende openbare eigenschappen met het kenmerk Alleen-lezen opgeven. Roep de RaiseExceptionIfNecessary() methode aan voordat u de eigenschapswaarde retourneert, voor het geval de bewerking is geannuleerd of er een fout is opgetreden.

Zie ook

• AsyncCompletedEventHandler
• AsyncOperationManager
• AsyncOperation
• Het Asynchrone patroon op basis van gebeurtenissen implementeren