BackgroundWorker.WorkerSupportsCancellation プロパティ

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

BackgroundWorker.WorkerSupportsCancellation プロパティ

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

BackgroundWorker が非同期のキャンセルをサポートしているかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property WorkerSupportsCancellation
 As Boolean

Visual Basic (使用法)

Dim instance As BackgroundWorker
Dim value As Boolean

value = instance.WorkerSupportsCancellation

instance.WorkerSupportsCancellation = value

C#

public bool WorkerSupportsCancellation { get;
 set; }

C++

public:
property bool WorkerSupportsCancellation {
    bool get ();
    void set (bool value);
}

J#

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

/** @property */
public void set_WorkerSupportsCancellation
 (boolean value)

JScript

public function get WorkerSupportsCancellation
 () : boolean

public function set WorkerSupportsCancellation
 (value : boolean)

プロパティ値
BackgroundWorker がキャンセルをサポートしている場合は true。それ以外の場合は false。既定値は false です。

解説

BackgroundWorker でキャンセルをサポートする場合は、WorkerSupportsCancellation プロパティに true を設定します。このプロパティが true の場合、CancelAsync メソッドを呼び出してバックグラウンド操作を中断できます。

プラットフォーム

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

参照

関連項目
BackgroundWorker クラス
BackgroundWorker メンバ
System.ComponentModel 名前空間
CancelAsync
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする