AsyncCompletedEventArgs.Cancelled Właściwość

Definicja

Pobiera wartość wskazującą, czy operacja asynchroniczna została anulowana.Gets a value indicating whether an asynchronous operation has been canceled.

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

Wartość właściwości

true, jeśli operacja w tle została anulowana; w przeciwnym razie false.true if the background operation has been canceled; otherwise false. Wartość domyślna to false.The default is false.

Przykłady

Poniższy przykład kodu demonstruje użycie AsyncOperation do śledzenia okresu istnienia operacji asynchronicznych.The following code example demonstrates the using an AsyncOperation to track the lifetime of asynchronous operations. Ten przykładowy kod jest częścią większego przykładu udostępnionego dla klasy System.ComponentModel.AsyncOperationManager.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

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

Uwagi

Gdy właściwość Cancelled jest true, operacja asynchroniczna została przerwana.When the Cancelled property is true, the asynchronous operation was interrupted.

Delegat programu obsługi zdarzeń aplikacji klienta powinien sprawdzić Właściwość Cancelled przed uzyskaniem dostępu do właściwości w klasie pochodnej z AsyncCompletedEventArgs; w przeciwnym razie Właściwość zgłosi InvalidOperationException, jeśli operacja asynchroniczna została przerwana.The client application's event-handler delegate should check the Cancelled property before accessing any properties in a class derived from AsyncCompletedEventArgs; otherwise, the property will raise an InvalidOperationException if the asynchronous operation was interrupted.

Uwagi dotyczące dziedziczenia

Jeśli w klasie pochodnej są podano właściwości tylko do odczytu, należy wywołać metodę RaiseExceptionIfNecessary().If you provide read-only properties in a derived class, be sure to call the RaiseExceptionIfNecessary() method. Uniemożliwia to klientom dostęp do właściwości, które są potencjalnie nieprawidłowe z powodu błędu w operacji asynchronicznej.This prevents clients from accessing properties that are potentially not valid due to a failure in the asynchronous operation.

Dotyczy

Zobacz też