DoWorkEventArgs.Argument プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

DoWorkEventArgs.Argument プロパティ

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

非同期操作の引数を表す値を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Argument As Object

Visual Basic (使用法)

Dim instance As DoWorkEventArgs
Dim value As Object

value = instance.Argument

public Object Argument { get; }

C++

public:
property Object^ Argument {
    Object^ get ();
}

/** @property */
public Object get_Argument ()

JScript

public function get Argument
 () : Object

プロパティ値
非同期操作の引数を表す Object。

使用例

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

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