DoWorkEventArgs 類別

定義

命名空間:

System.ComponentModel

組件:

netstandard.dll, 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 。 完整程式碼列表請參見 「如何：在背景執行操作」。

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

建構函式

名稱	Description
DoWorkEventArgs(Object)	初始化 DoWorkEventArgs 類別的新執行個體。

屬性

名稱	Description
Argument	會得到一個代表非同步操作參數的值。
Cancel	取得或設定一個值，指示事件是否應被取消。 (繼承來源 CancelEventArgs)
Result	取得或設定一個代表非同步操作結果的值。

方法

名稱	Description
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)

另請參閱

• BackgroundWorker
• 如何在背景執行操作: