AsyncCompletedEventArgs Třída

  • Reference

Definice

Obor názvů:
System.ComponentModel
Sestavení:
System.ComponentModel.EventBasedAsync.dll
Sestavení:
System.dll
Sestavení:
netstandard.dll
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs

Poskytuje data pro MethodNameCompleted událost.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Dědičnost
Object
EventArgs
AsyncCompletedEventArgs
Odvozené

Příklady

Následující příklad kódu ukazuje použití ke AsyncOperation sledování životnosti asynchronních operací. Tento příklad kódu je součástí většího příkladu System.ComponentModel.AsyncOperationManager pro třídu .

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

Poznámky

Pokud používáte třídu, která implementuje přehled asynchronního vzoru založeného na událostech, třída poskytne MethodNameCompleted událost. Pokud do události přidáte instanci System.ComponentModel.AsyncCompletedEventHandler delegáta, obdržíte informace o výsledku asynchronních operací v parametru AsyncCompletedEventArgs odpovídající metody obslužné rutiny událostí.

Delegát obslužné rutiny událostí klientské aplikace může zkontrolovat Cancelled vlastnost a zjistit, jestli byla asynchronní úloha zrušena.

Delegát obslužné rutiny událostí klientské aplikace může zkontrolovat Error vlastnost a zjistit, jestli během provádění asynchronní úlohy nedošlo k výjimce.

Pokud třída podporuje více asynchronních metod nebo více volání stejné asynchronní metody, můžete určit, která úloha vyvolala MethodNameCompleted událost kontrolou hodnoty UserState vlastnosti . Váš kód bude muset sledovat tyto tokeny, označované jako ID úloh, protože jejich odpovídající asynchronní úlohy se spouští a dokončují.

Poznámky pro dědice

Třídy, které se řídí asynchronním vzorem založeným na událostech, mohou vyvolat události upozorňující klienty na stav čekajících asynchronních operací. Pokud třída poskytuje MethodNameCompleted událost, můžete použít AsyncCompletedEventArgs k informovat klienty o výsledku asynchronních operací.

Možná budete chtít klientům sdělit více informací o výsledku asynchronní operace, než jaké AsyncCompletedEventArgs poskytuje. V tomto případě můžete z AsyncCompletedEventArgs třídy odvodit vlastní třídu a poskytnout další proměnné privátní instance a odpovídající veřejné vlastnosti jen pro čtení. Volejte metodu RaiseExceptionIfNecessary() před vrácením hodnoty vlastnosti v případě, že byla operace zrušena nebo došlo k chybě.

Konstruktory

AsyncCompletedEventArgs()
Zastaralé.

Inicializuje novou instanci AsyncCompletedEventArgs třídy .
AsyncCompletedEventArgs(Exception, Boolean, Object)

Inicializuje novou instanci AsyncCompletedEventArgs třídy .

Vlastnosti

Cancelled

Získá hodnotu označující, zda asynchronní operace byla zrušena.
Error

Získá hodnotu označující, ke které chybě došlo během asynchronní operace.
UserState

Získá jedinečný identifikátor asynchronní úlohy.

Metody

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí hashovací funkce.

(Zděděno od Object)
GetType()

Type Získá z aktuální instance.

(Zděděno od Object)
MemberwiseClone()

Vytvoří mělkou kopii aktuálního Objectsouboru .

(Zděděno od Object)
RaiseExceptionIfNecessary()

Vyvolá výjimku zadanou uživatelem, pokud asynchronní operace selhala.
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Platí pro

Viz také