AsyncCompletedEventArgs Classe

  • Riferimento

Definizione

Spazio dei nomi:
System.ComponentModel
Assembly:
System.ComponentModel.EventBasedAsync.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
AsyncCompletedEvent.cs
Source:
AsyncCompletedEvent.cs
Source:
AsyncCompletedEvent.cs

Fornisce dati per l'evento MethodNameCompleted .

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Ereditarietà
Object
EventArgs
AsyncCompletedEventArgs
Derivato

Esempio

Nell'esempio di codice seguente viene illustrato l'uso di un AsyncOperation oggetto per tenere traccia della durata delle operazioni asincrone. Questo esempio di codice fa parte di un esempio più grande fornito per la System.ComponentModel.AsyncOperationManager classe.

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

Commenti

Se si usa una classe che implementa la panoramica asincrona basata su eventi, la classe fornirà un evento MethodNameCompleted . Se si aggiunge un'istanza System.ComponentModel.AsyncCompletedEventHandler del delegato all'evento, si riceveranno informazioni sul risultato delle operazioni asincrone nel AsyncCompletedEventArgs parametro del metodo del gestore eventi corrispondente.

Il delegato del gestore eventi dell'applicazione client può controllare la Cancelled proprietà per determinare se l'attività asincrona è stata annullata.

Il delegato del gestore eventi dell'applicazione client può controllare la Error proprietà per determinare se si è verificata un'eccezione durante l'esecuzione dell'attività asincrona.

Se la classe supporta più metodi asincroni o più chiamate allo stesso metodo asincrono, è possibile determinare quale attività ha generato l'evento MethodNameCompleted controllando il valore della UserState proprietà. Il codice dovrà tenere traccia di questi token, noti come ID attività, come attività corrispondenti avviare e completare le attività asincrone corrispondenti.

Note per gli eredi

Le classi che seguono il modello asincrono basato su eventi possono generare eventi per avvisare i client sullo stato delle operazioni asincrone in sospeso. Se la classe fornisce un evento MethodNameCompleted , è possibile usare per AsyncCompletedEventArgs indicare ai client il risultato delle operazioni asincrone.

È possibile comunicare ai client altre informazioni sul risultato di un'operazione asincrona rispetto a un'operazione AsyncCompletedEventArgs ospitata. In questo caso, è possibile derivare la propria classe dalla AsyncCompletedEventArgs classe e fornire variabili di istanza private aggiuntive e proprietà pubbliche di sola lettura corrispondenti. Chiamare il metodo prima di restituire il RaiseExceptionIfNecessary() valore della proprietà, nel caso in cui l'operazione sia stata annullata o si è verificato un errore.

Costruttori

AsyncCompletedEventArgs()
Obsoleti.

Inizializza una nuova istanza della classe AsyncCompletedEventArgs.
AsyncCompletedEventArgs(Exception, Boolean, Object)

Inizializza una nuova istanza della classe AsyncCompletedEventArgs.

Proprietà

Cancelled

Ottiene un valore che indica se un'operazione asincrona è stata annullata.
Error

Ottiene un valore che indica l'errore verificatosi durante un'operazione asincrona.
UserState

Ottiene l’identificatore univoco per l'attività asincrona.

Metodi

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
RaiseExceptionIfNecessary()

Genera un'eccezione fornita dall'utente in caso di errore in un'operazione asincrona.
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Si applica a

Vedi anche