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 クラス
その他の技術情報
方法 : バックグラウンドで操作を実行する