AsyncCompletedEventArgs Osztály

Definíció

Névtér:
System.ComponentModel
Szerelvények:
System.dll, System.ComponentModel.EventBasedAsync.dll
Szerelvény:
System.dll
Szerelvény:
netstandard.dll

Adatokat biztosít a MethodNameCompleted eseményhez.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Öröklődés
Object
EventArgs
AsyncCompletedEventArgs
Származtatott

Példák

Az alábbi példakód egy aszinkron AsyncOperation műveletek élettartamának nyomon követésére szolgál. Ez a példakód egy nagyobb, az System.ComponentModel.AsyncOperationManager osztályhoz tartozó példa része.

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

Megjegyzések

Ha olyan osztályt használ, amely megvalósítja az eseményalapú aszinkron minta áttekintését, az osztály egy MethodName-eseménytCompleted fog biztosítani. Ha hozzáadja a System.ComponentModel.AsyncCompletedEventHandler meghatalmazott egy példányát az eseményhez, a megfelelő eseménykezelő metódus paraméterében információt fog kapni az AsyncCompletedEventArgs aszinkron műveletek eredményéről.

Az ügyfélalkalmazás eseménykezelő delegáltja ellenőrizheti a Cancelled tulajdonságot annak megállapításához, hogy az aszinkron feladat megszakadt-e.

Az ügyfélalkalmazás eseménykezelő meghatalmazottja ellenőrizheti a Error tulajdonságot annak megállapításához, hogy történt-e kivétel az aszinkron feladat végrehajtása során.

Ha az osztály több aszinkron metódust támogat, vagy több hívást is ugyanarra az aszinkron metódusra, a tulajdonság értékének ellenőrzésével meghatározhatjaUserState, hogy melyik tevékenység okozta a MethodNameCompleted eseményt. A kódnak nyomon kell követnie ezeket a jogkivonatokat, más néven feladatazonosítókat, mivel a megfelelő aszinkron tevékenységek elindulnak és befejeződnek.

Megjegyzések az öröklőkhöz

Az eseményalapú aszinkron mintát követő osztályok eseményeket hozhatnak létre, hogy riasztást küldhessenek az ügyfeleknek a függőben lévő aszinkron műveletek állapotáról. Ha az osztály egy MethodNameCompleted eseményt biztosít, a segítségével tájékoztathatja az AsyncCompletedEventArgs ügyfeleket az aszinkron műveletek eredményéről.

Előfordulhat, hogy több információt szeretne az ügyfelekkel kommunikálni az aszinkron művelet eredményéről, mint egy AsyncCompletedEventArgs befogadó. Ebben az esetben saját osztályt hozhat létre az AsyncCompletedEventArgs osztályból, és további privát példányváltozókat és megfelelő írásvédett nyilvános tulajdonságokat is megadhat. A tulajdonságérték visszaadása előtt hívja meg a RaiseExceptionIfNecessary() metódust, ha a műveletet megszakították, vagy hiba történt.

Konstruktorok

Name Description
AsyncCompletedEventArgs()
Elavult.

Inicializálja a AsyncCompletedEventArgs osztály új példányát.
AsyncCompletedEventArgs(Exception, Boolean, Object)

Inicializálja a AsyncCompletedEventArgs osztály új példányát.

Tulajdonságok

Name Description
Cancelled

Beolvas egy értéket, amely jelzi, hogy egy aszinkron művelet megszakadt-e.
Error

Egy értéket kap, amely jelzi, hogy melyik hiba történt egy aszinkron művelet során.
UserState

Lekéri az aszinkron tevékenység egyedi azonosítót.

Metódusok

Name Description
Equals(Object)

Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal.

(Öröklődés forrása Object)
GetHashCode()

Ez az alapértelmezett kivonatoló függvény.

(Öröklődés forrása Object)
GetType()

Lekéri az Type aktuális példányt.

(Öröklődés forrása Object)
MemberwiseClone()

Az aktuális Objectpéldány sekély másolatát hozza létre.

(Öröklődés forrása Object)
RaiseExceptionIfNecessary()

Felhasználó által megadott kivételt hoz létre, ha egy aszinkron művelet meghiúsult.
ToString()

Az aktuális objektumot jelképező sztringet ad vissza.

(Öröklődés forrása Object)

A következőre érvényes:

Lásd még