AsyncCompletedEventArgs.Cancelled Özellik

  • Başvuru

Tanım

Ad Alanı:
System.ComponentModel
Bütünleştirilmiş Kod:
System.ComponentModel.EventBasedAsync.dll
Bütünleştirilmiş Kod:
System.dll
Bütünleştirilmiş Kod:
netstandard.dll
Kaynak:
AsyncCompletedEvent.cs
Kaynak:
AsyncCompletedEvent.cs
Kaynak:
AsyncCompletedEvent.cs

Zaman uyumsuz işlemin iptal edilip edilmediğini belirten bir değer alır.

public:
 property bool Cancelled { bool get(); };
public bool Cancelled { get; }
member this.Cancelled : bool
Public ReadOnly Property Cancelled As Boolean

Özellik Değeri

Boolean

true arka plan işlemi iptal edildiyse; aksi takdirde false. Varsayılan değer: false.

Örnekler

Aşağıdaki kod örneği, zaman uyumsuz işlemlerin ömrünü izlemek için kullanma AsyncOperation işlemini gösterir. Bu kod örneği, sınıfı için System.ComponentModel.AsyncOperationManager sağlanan daha büyük bir örneğin parçasıdır.

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

Açıklamalar

Cancelled özelliği olduğundatrue, zaman uyumsuz işlem kesildi.

İstemci uygulamanın olay işleyicisi temsilcisi, öğesinden AsyncCompletedEventArgstüretilen bir sınıftaki özelliklere erişmeden önce özelliğini denetlemelidirCancelled; aksi takdirde, zaman uyumsuz işlem kesintiye uğrarsa özelliği bir InvalidOperationException oluşturur.

Devralanlara Notlar

Türetilmiş bir sınıfta salt okunur özellikler sağlarsanız yöntemini çağırdığınızdan RaiseExceptionIfNecessary() emin olun. Bu, istemcilerin zaman uyumsuz işlemdeki bir hata nedeniyle geçerli olmayabilecek özelliklere erişmesini engeller.

Şunlara uygulanır

Ayrıca bkz.