DoWorkEventArgs

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

DoWorkEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

DoWork イベント ハンドラのデータを提供します。

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

Visual Basic (宣言)

Public Class DoWorkEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As DoWorkEventArgs

C#

public class DoWorkEventArgs : CancelEventArgs

C++

public ref class DoWorkEventArgs : public
 CancelEventArgs

J#

public class DoWorkEventArgs extends CancelEventArgs

JScript

public class DoWorkEventArgs extends
 CancelEventArgs

解説

メモ
このクラスに適用される HostProtectionAttribute 属性の Resources プロパティの値は、SharedState です。HostProtectionAttribute は、デスクトップ アプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

使用例

DoWorkEventArgs クラスを使用して DoWork イベントを処理する方法を示すコード例を次に示します。完全なコードの一覧については、「方法 : バックグラウンドで操作を実行する」を参照してください。

Visual Basic

Private Sub backgroundWorker1_DoWork( _
sender As Object, e As DoWorkEventArgs)
 _
Handles backgroundWorker1.DoWork

   ' Do not access the form's BackgroundWorker reference directly.
   ' Instead, use the reference provided by the sender parameter.
   Dim bw As BackgroundWorker = CType( sender,
 BackgroundWorker )
   
   ' Extract the argument.
   Dim arg As Integer =
 Fix(e.Argument)
   
   ' Start the time-consuming operation.
   e.Result = TimeConsumingOperation(bw, arg)
   
   ' If the operation was canceled by the user, 
   ' set the DoWorkEventArgs.Cancel property to true.
   If bw.CancellationPending Then
      e.Cancel = True
   End If

End Sub   

C#

private void backgroundWorker1_DoWork(object
 sender, DoWorkEventArgs e)
{
    // Do not access the form's BackgroundWorker reference directly.
    // Instead, use the reference provided by the sender parameter.
    BackgroundWorker bw = sender as BackgroundWorker;

    // Extract the argument.
    int arg = (int)e.Argument;

    // Start the time-consuming operation.
    e.Result = TimeConsumingOperation(bw, arg);

    // If the operation was canceled by the user, 
    // set the DoWorkEventArgs.Cancel property to true.
    if (bw.CancellationPending)
    {
        e.Cancel = true;
    }
}

継承階層

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.ComponentModel.DoWorkEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

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

DoWorkEventArgs コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

DoWorkEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    argument As Object _
)

Visual Basic (使用法)

Dim argument As Object

Dim instance As New DoWorkEventArgs(argument)

C#

public DoWorkEventArgs (
    Object argument
)

C++

public:
DoWorkEventArgs (
    Object^ argument
)

J#

public DoWorkEventArgs (
    Object argument
)

JScript

public function DoWorkEventArgs (
    argument : Object
)

パラメータ

argument

非同期操作の引数を指定します。

プラットフォーム

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

参照

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

DoWorkEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Argument	非同期操作の引数を表す値を取得します。
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	Result	非同期操作の結果を表す値を取得または設定します。

参照

関連項目

DoWorkEventArgs クラス
System.ComponentModel 名前空間
BackgroundWorker クラス

その他の技術情報

方法 : バックグラウンドで操作を実行する

DoWorkEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

DoWorkEventArgs クラス
System.ComponentModel 名前空間
BackgroundWorker クラス

その他の技術情報

方法 : バックグラウンドで操作を実行する

DoWorkEventArgs メンバ

DoWork イベント ハンドラのデータを提供します。

DoWorkEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	DoWorkEventArgs	DoWorkEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Argument	非同期操作の引数を表す値を取得します。
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	Result	非同期操作の結果を表す値を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

DoWorkEventArgs クラス
System.ComponentModel 名前空間
BackgroundWorker クラス

その他の技術情報

方法 : バックグラウンドで操作を実行する