AsyncCompletedEventArgs Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje data pro událost MethodNameCompleted .
public ref class AsyncCompletedEventArgs : EventArgspublic class AsyncCompletedEventArgs : EventArgstype AsyncCompletedEventArgs = class
inherit EventArgsPublic Class AsyncCompletedEventArgs
Inherits EventArgs- Dědičnost
- Odvozené
Příklady
Následující příklad kódu ukazuje použití AsyncOperation ke sledování životnosti asynchronních operací. Tento příklad kódu je součástí většího příkladu uvedeného pro třídu System.ComponentModel.AsyncOperationManager.
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
Poznámky
Pokud používáte třídu, která implementuje přehled asynchronního vzoru založeného na událostech, třída poskytne událost MethodNameCompleted . Pokud do události přidáte instanci System.ComponentModel.AsyncCompletedEventHandler delegáta, obdržíte informace o výsledku asynchronních operací v AsyncCompletedEventArgs parametru odpovídající metody obslužné rutiny události.
Delegát obslužné rutiny události klientské aplikace může zkontrolovat Cancelled vlastnost a určit, jestli byla asynchronní úloha zrušena.
Delegát obslužné rutiny události klientské aplikace může zkontrolovat Error vlastnost a určit, zda během provádění asynchronní úlohy doš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 událost MethodNameCompleted kontrolou hodnoty UserState vlastnosti. Váš kód bude muset tyto tokeny, označované jako ID úkolů, sledovat jako jejich odpovídající asynchronní úkoly, které jsou spuštěny a dokončeny.
Poznámky pro dědice
Třídy, které následují podle asynchronního vzoru založeného na událostech, mohou vyvolat události, které upozorňují klienty na stav čekajících asynchronních operací. Pokud třída poskytuje událost MethodNameCompleted , můžete použít AsyncCompletedEventArgs k informovat klienty o výsledku asynchronních operací.
Klientům můžete chtít sdělit více informací o výsledku asynchronní operace, než je AsyncCompletedEventArgs potřeba. V tomto případě můžete odvodit vlastní třídu z AsyncCompletedEventArgs třídy a poskytnout další proměnné privátní instance a odpovídající veřejné vlastnosti jen pro čtení. RaiseExceptionIfNecessary() Před vrácením hodnoty vlastnosti zavolejte metodu pro případ, že byla operace zrušena nebo došlo k chybě.
Konstruktory
| Name | Description |
|---|---|
| AsyncCompletedEventArgs() |
Zastaralé.
Inicializuje novou instanci AsyncCompletedEventArgs třídy. |
| AsyncCompletedEventArgs(Exception, Boolean, Object) |
Inicializuje novou instanci AsyncCompletedEventArgs třídy. |
Vlastnosti
| Name | Description |
|---|---|
| Cancelled |
Získá hodnotu určující, zda asynchronní operace byla zrušena. |
| Error |
Získá hodnotu určující, ke které chybě došlo během asynchronní operace. |
| UserState |
Získá jedinečný identifikátor pro asynchronní úlohu. |
Metody
| Name | Description |
|---|---|
| Equals(Object) |
Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object) |
| GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (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) |
