AsyncCompletedEventArgs Klasa

  • Odwołanie

Definicja

Przestrzeń nazw:
System.ComponentModel
Zestaw:
System.ComponentModel.EventBasedAsync.dll
Zestaw:
System.dll
Zestaw:
netstandard.dll
Źródło:
AsyncCompletedEvent.cs
Źródło:
AsyncCompletedEvent.cs
Źródło:
AsyncCompletedEvent.cs

Udostępnia dane zdarzenia MethodNameCompleted .

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Dziedziczenie
Object
EventArgs
AsyncCompletedEventArgs
Pochodne

Przykłady

W poniższym przykładzie kodu pokazano użycie elementu do AsyncOperation śledzenia okresu istnienia operacji asynchronicznych. Ten przykład kodu jest częścią większego przykładu podanego System.ComponentModel.AsyncOperationManager dla klasy.

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

Uwagi

Jeśli używasz klasy, która implementuje asynchroniczne omówienie wzorca opartego na zdarzeniach, klasa udostępni zdarzenie MethodNameCompleted . Jeśli dodasz wystąpienie delegata System.ComponentModel.AsyncCompletedEventHandler do zdarzenia, otrzymasz informacje o wyniku operacji asynchronicznych w AsyncCompletedEventArgs parametrze odpowiedniej metody obsługi zdarzeń.

Delegat obsługi zdarzeń aplikacji klienckiej może sprawdzić właściwość, Cancelled aby określić, czy zadanie asynchroniczne zostało anulowane.

Delegat obsługi zdarzeń aplikacji klienckiej może sprawdzić właściwość, Error aby określić, czy wystąpił wyjątek podczas wykonywania zadania asynchronicznego.

Jeśli klasa obsługuje wiele metod asynchronicznych lub wiele wywołań do tej samej metody asynchronicznej, możesz określić, które zadanie wzbudziło zdarzenie MethodNameCompleted , sprawdzając wartość UserState właściwości. Kod będzie musiał śledzić te tokeny, znane jako identyfikatory zadań, jako odpowiadające im zadania asynchroniczne, uruchamiane i wykonywane.

Uwagi dotyczące dziedziczenia

Klasy zgodne ze wzorcem asynchronicznym opartym na zdarzeniach mogą zgłaszać zdarzenia w celu powiadamiania klientów o stanie oczekujących operacji asynchronicznych. Jeśli klasa udostępnia zdarzenie MethodNameCompleted , możesz użyć polecenia AsyncCompletedEventArgs , aby poinformować klientów o wyniku operacji asynchronicznych.

Możesz chcieć komunikować się z klientami więcej informacji na temat wyniku operacji asynchronicznej niż AsyncCompletedEventArgs uwzględnić. W takim przypadku możesz utworzyć własną klasę z AsyncCompletedEventArgs klasy i podać dodatkowe zmienne wystąpienia prywatnego oraz odpowiednie właściwości publiczne tylko do odczytu. Wywołaj metodę RaiseExceptionIfNecessary() przed zwróceniem wartości właściwości, jeśli operacja została anulowana lub wystąpił błąd.

Konstruktory

AsyncCompletedEventArgs()
Przestarzałe.

Inicjuje nowe wystąpienie klasy AsyncCompletedEventArgs.
AsyncCompletedEventArgs(Exception, Boolean, Object)

Inicjuje nowe wystąpienie klasy AsyncCompletedEventArgs.

Właściwości

Cancelled

Pobiera wartość wskazującą, czy operacja asynchroniczna została anulowana.
Error

Pobiera wartość wskazującą, który błąd wystąpił podczas operacji asynchronicznej.
UserState

Pobiera unikatowy identyfikator zadania asynchronicznego.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetType()

Type Pobiera bieżące wystąpienie.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
RaiseExceptionIfNecessary()

Zgłasza wyjątek dostarczony przez użytkownika, jeśli operacja asynchroniczna nie powiodła się.
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Dotyczy

Zobacz też