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
• 作法：在背景執行作業