DoWorkEventArgs クラス

定義

名前空間:

System.ComponentModel

アセンブリ:

System.ComponentModel.EventBasedAsync.dll

ソース:

DoWorkEvent.cs

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

public ref class DoWorkEventArgs : System::ComponentModel::CancelEventArgs

public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs

type DoWorkEventArgs = class
    inherit CancelEventArgs

Public Class DoWorkEventArgs
Inherits CancelEventArgs

継承

Object

EventArgs

CancelEventArgs

DoWorkEventArgs

例

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

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;
    }
}

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

コンストラクター

DoWorkEventArgs(Object)

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

プロパティ

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

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

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