AsyncCompletedEventArgs 类

  • 参考

定义

命名空间:
System.ComponentModel
程序集:
System.ComponentModel.EventBasedAsync.dll
程序集:
System.dll
程序集:
netstandard.dll
Source:
AsyncCompletedEvent.cs
Source:
AsyncCompletedEvent.cs
Source:
AsyncCompletedEvent.cs

为 MethodNameCompleted 事件提供数据。

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
继承
Object
EventArgs
AsyncCompletedEventArgs
派生

示例

下面的代码示例演示如何使用 AsyncOperation 来跟踪异步操作的生存期。 此代码示例是为 System.ComponentModel.AsyncOperationManager 类提供的一个更大示例的一部分。

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

注解

如果使用实现 基于事件的异步模式概述的类，该类将提供 MethodNameCompleted 事件。 如果将委托的 System.ComponentModel.AsyncCompletedEventHandler 实例添加到事件，则会在相应事件处理程序方法的 参数中 AsyncCompletedEventArgs 收到有关异步操作结果的信息。

客户端应用程序的事件处理程序委托可以检查 Cancelled 属性，以确定异步任务是否已取消。

客户端应用程序的事件处理程序委托可以检查 Error 属性，以确定在执行异步任务期间是否发生了异常。

如果 类支持多个异步方法或对同一异步方法的多次调用，则可以通过检查 属性的值UserState来确定哪个任务引发了 MethodNameCompleted 事件。 代码需要跟踪这些令牌（称为任务 ID），因为它们对应的异步任务开始和完成。

继承者说明

遵循基于事件的异步模式的类可以引发事件，以提醒客户端挂起的异步操作的状态。 如果 类提供 MethodNameCompleted 事件，则可以使用 AsyncCompletedEventArgs 告知客户端异步操作的结果。

你可能希望与客户端传达有关异步操作结果的更多信息， AsyncCompletedEventArgs 而不是 适应。 在这种情况下，可以从 类派生自己的类， AsyncCompletedEventArgs 并提供其他私有实例变量和相应的只读公共属性。 RaiseExceptionIfNecessary()在返回属性值之前调用 方法，以防操作被取消或发生错误。

构造函数

AsyncCompletedEventArgs()
已过时.

初始化 AsyncCompletedEventArgs 类的新实例。
AsyncCompletedEventArgs(Exception, Boolean, Object)

初始化 AsyncCompletedEventArgs 类的新实例。

属性

Cancelled

获取一个值，该值指示异步操作是否已被取消。
Error

获取一个值，该值指示异步操作期间发生的错误。
UserState

获取异步任务的唯一标识符。

方法

Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetType()

获取当前实例的 Type。

(继承自 Object)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
RaiseExceptionIfNecessary()

如果异步操作失败，则引发用户提供的异常。
ToString()

返回表示当前对象的字符串。

(继承自 Object)

适用于

另请参阅