RunWorkerCompletedEventArgs クラス

  • リファレンス

定義

名前空間:
System.ComponentModel
アセンブリ:
System.dll, System.ComponentModel.EventBasedAsync.dll
アセンブリ:
System.ComponentModel.EventBasedAsync.dll
アセンブリ:
System.dll
アセンブリ:
netstandard.dll
ソース:
RunWorkerCompletedEvent.cs
ソース:
RunWorkerCompletedEvent.cs
ソース:
RunWorkerCompletedEvent.cs

MethodNameCompleted イベントのデータを提供します。

public ref class RunWorkerCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs
public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs
type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs
Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs
継承
Object
EventArgs
AsyncCompletedEventArgs
RunWorkerCompletedEventArgs

例

RunWorkerCompletedEventArgs の使用方法を次のコード例に示します。 この例は、 クラスの大きなサンプルの BackgroundWorker 一部です。

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted( Object^ /*sender*/, RunWorkerCompletedEventArgs^ e )
{
   // First, handle the case where an exception was thrown.
   if ( e->Error != nullptr )
   {
      MessageBox::Show( e->Error->Message );
   }
   else
   if ( e->Cancelled )
   {
      // Next, handle the case where the user cancelled 
      // the operation.
      // Note that due to a race condition in 
      // the DoWork event handler, the Cancelled
      // flag may not have been set, even though
      // CancelAsync was called.
      resultLabel->Text = "Cancelled";
   }
   else
   {
      // Finally, handle the case where the operation 
      // succeeded.
      resultLabel->Text = e->Result->ToString();
   }

   // Enable the UpDown control.
   this->numericUpDown1->Enabled = true;

   // Enable the Start button.
   startAsyncButton->Enabled = true;

   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}

// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    {
        MessageBox.Show(e.Error.Message);
    }
    else if (e.Cancelled)
    {
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
    }
    else
    {
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();
    }

    // Enable the UpDown control.
    this.numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}

' This event handler deals with the results of the
' background operation.
Private Sub backgroundWorker1_RunWorkerCompleted( _
ByVal sender As Object, ByVal e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

    ' First, handle the case where an exception was thrown.
    If (e.Error IsNot Nothing) Then
        MessageBox.Show(e.Error.Message)
    ElseIf e.Cancelled Then
        ' Next, handle the case where the user canceled the 
        ' operation.
        ' Note that due to a race condition in 
        ' the DoWork event handler, the Cancelled
        ' flag may not have been set, even though
        ' CancelAsync was called.
        resultLabel.Text = "Canceled"
    Else
        ' Finally, handle the case where the operation succeeded.
        resultLabel.Text = e.Result.ToString()
    End If

    ' Enable the UpDown control.
    Me.numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

    ' Disable the Cancel button.
    cancelAsyncButton.Enabled = False
End Sub

注釈

非同期操作にイベント ベースの非同期パターンを使用する場合、Windows フォームフォームまたはコントロールは メソッドを呼び出して非同期操作をBackgroundWorker.RunWorkerAsync開始します。 メソッドは、イベントを BackgroundWorker.DoWork 非同期的に発生させ、インスタンスを DoWorkEventArgs 渡します。 非同期操作が値を返す場合、 BackgroundWorker.DoWork イベント ハンドラーは通常、それを プロパティに DoWorkEventArgs.Result 割り当てます。 非同期操作が完了すると、イベントが発生し、 BackgroundWorker.RunWorkerCompleted 操作の状態に関する情報 (取り消された、エラーが発生した、または正常に完了したかどうか) を含むインスタンスが渡 RunWorkerCompletedEventArgs されます。 正常に完了した場合、その Result プロパティには、非同期操作によって返され、以前に プロパティに割り当てられた値が DoWorkEventArgs.Result 含まれます。

注意

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

コンストラクター

RunWorkerCompletedEventArgs(Object, Exception, Boolean)

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

プロパティ

Cancelled

非同期操作がキャンセルされたかどうかを示す値を取得します。

(継承元 AsyncCompletedEventArgs)
Error

非同期操作中に発生したエラーを示す値を取得します。

(継承元 AsyncCompletedEventArgs)
Result

非同期操作の結果を表す値を取得します。
UserState

ユーザーの状態を表す値を取得します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
RaiseExceptionIfNecessary()

非同期操作が失敗した場合は、ユーザー指定の例外を発生させます。

(継承元 AsyncCompletedEventArgs)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください