AsyncCompletedEventArgs.Cancelled プロパティ

.NET Framework クラス ライブラリ リファレンス

AsyncCompletedEventArgs.Cancelled プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

非同期操作がキャンセルされたかどうかを示す値を取得します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 Cancelled As Boolean

Visual Basic (使用法)

Dim instance As AsyncCompletedEventArgs
Dim value As Boolean

value = instance.Cancelled

C#

public bool Cancelled { get;
 }

C++

public:
property bool Cancelled {
    bool get ();
}

J#

/** @property */
public boolean get_Cancelled ()

JScript

public function get Cancelled
 () : boolean

プロパティ値
バックグラウンドでの操作がキャンセルされた場合は true。それ以外の場合は false。既定値は false です。

解説

Cancelled プロパティが true である場合は、非同期操作が中断されています。

クライアント アプリケーションのイベント ハンドラ デリゲートは、AsyncCompletedEventArgs から派生したクラスのプロパティにアクセスする前に、Cancelled プロパティをチェックする必要があります。チェックしなかった場合、非同期操作が中断されたときにプロパティが InvalidOperationException を発生させます。

継承時の注意 派生クラスで読み取り専用プロパティを提供する場合は、必ず RaiseExceptionIfNecessary メソッドを呼び出します。これにより、非同期操作でのエラーが原因で無効化されている可能性のあるプロパティにクライアントがアクセスするのを防ぐことができます。

使用例

AsyncOperation を使用して非同期操作の有効期間を追跡するコード例を次に示します。このコード例は、System.ComponentModel.AsyncOperationManager クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

Imports System
Imports System.Collections
Imports System.Collections.Specialized
Imports System.ComponentModel
Imports System.Drawing
Imports System.Globalization
Imports System.Threading
Imports System.Windows.Forms
<br /><span space="preserve">...</span><br
 />    ' 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 Not (lvi Is
 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 Not (lvi Is
 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 Not (lvi Is
 Nothing) Then
                lvi.BackColor = Color.LightGray
                lvi.Tag = Nothing
            End If
        End If

    End Sub

C#

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;
<br /><span space="preserve">...</span><br /> 
       // 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;
                }
            }
        }

J#

import System.*;
import System.Collections.*;
import System.Collections.Specialized.*;
import System.ComponentModel.*;
import System.Data.*;
import System.Drawing.*;
import System.Threading.*;
import System.Windows.Forms.*;

<br /><span space="preserve">...</span><br /> 
   private void primeNumberCalculator1_CalculatePrimeCompleted(Object
 sender,
        CalculatePrimeCompletedEventArgs e)
    {
        Guid guid = (Guid)e.get_UserState();
        if (e.get_Cancelled()) {
            String result = "Cancelled";
            ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                result);
            if (lvi != null) {
                lvi.set_BackColor(Color.get_Pink());
                lvi.set_Tag(null);
            }
        }
        else {
            if (e.get_Error() != null) {
                String result = "Error";
                ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                    result);
                if (lvi != null) {
                    lvi.set_BackColor(Color.get_Red());
                    lvi.set_ForeColor(Color.get_White());
                    lvi.set_Tag(null);
                }
            }
            else {
                boolean result = e.get_IsPrime();
                ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                    result, e.get_FirstDivisor());
                if (lvi != null) {
                    lvi.set_BackColor(Color.get_LightGray());
                    lvi.set_Tag(null);
                }
            }
        }
    } //primeNumberCalculator1_CalculatePrimeCompleted

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
AsyncCompletedEventArgs クラス
AsyncCompletedEventArgs メンバ
System.ComponentModel 名前空間
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation
その他の技術情報
イベントベースの非同期パターンの実装