BackgroundWorker.DoWork 事件

定义

命名空间:

System.ComponentModel

程序集:

System.ComponentModel.EventBasedAsync.dll

Source:

BackgroundWorker.cs

调用 RunWorkerAsync() 时发生。

public:
 event System::ComponentModel::DoWorkEventHandler ^ DoWork;

public event System.ComponentModel.DoWorkEventHandler? DoWork;

member this.DoWork : System.ComponentModel.DoWorkEventHandler 

Public Custom Event DoWork As DoWorkEventHandler 

事件类型

DoWorkEventHandler

示例

下面的代码示例演示如何使用 DoWork 事件启动异步操作。 此代码示例是为 BackgroundWorker 类提供的一个更大示例的一部分。

// This event handler is where the actual,
// potentially time-consuming work is done.
void backgroundWorker1_DoWork( Object^ sender, DoWorkEventArgs^ e )
{
   // Get the BackgroundWorker that raised this event.
   BackgroundWorker^ worker = dynamic_cast<BackgroundWorker^>(sender);

   // Assign the result of the computation
   // to the Result property of the DoWorkEventArgs
   // object. This is will be available to the 
   // RunWorkerCompleted eventhandler.
   e->Result = ComputeFibonacci( safe_cast<Int32>(e->Argument), worker, e );
}

// This event handler is where the actual,
// potentially time-consuming work is done.
private void backgroundWorker1_DoWork(object sender, 
    DoWorkEventArgs e)
{   
    // Get the BackgroundWorker that raised this event.
    BackgroundWorker worker = sender as BackgroundWorker;

    // Assign the result of the computation
    // to the Result property of the DoWorkEventArgs
    // object. This is will be available to the 
    // RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci((int)e.Argument, worker, e);
}

' This event handler is where the actual work is done.
Private Sub backgroundWorker1_DoWork( _
ByVal sender As Object, _
ByVal e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

    ' Get the BackgroundWorker object that raised this event.
    Dim worker As BackgroundWorker = _
        CType(sender, BackgroundWorker)

    ' Assign the result of the computation
    ' to the Result property of the DoWorkEventArgs
    ' object. This is will be available to the 
    ' RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci(e.Argument, worker, e)
End Sub

注解

调用 方法时会引发此 RunWorkerAsync 事件。 这是开始执行可能耗时的工作的操作的位置。

事件处理程序中的DoWork代码应定期检查CancellationPending属性值，如果true为 ，则中止操作。 发生这种情况时，可以将 的 标志设置为 Canceltrue，事件处理程序Cancelled中的 RunWorkerCompleted 标志System.ComponentModel.RunWorkerCompletedEventArgs将设置为 true。System.ComponentModel.DoWorkEventArgs

注意

请注意，事件处理程序中的 DoWork 代码可能会在发出取消请求时完成其工作，并且轮询循环可能会错过 CancellationPending 设置为 true。 在这种情况下，即使发出了取消请求，Cancelled事件处理程序中的 RunWorkerCompleted 标志System.ComponentModel.RunWorkerCompletedEventArgs也不会设置为 true。 这种情况称为 争用条件 ，是多线程编程中常见的问题。 有关多线程设计问题的详细信息，请参阅 托管线程处理最佳做法。

如果操作生成结果，可以将结果分配给 DoWorkEventArgs.Result 属性。 此属性将可用于 属性中的RunWorkerCompletedRunWorkerCompletedEventArgs.Result事件处理程序。

如果 操作引发代码未处理的异常， BackgroundWorker 将捕获该异常并将其 RunWorkerCompleted 传递到事件处理程序中，在该事件处理程序中，它作为 Error 的 System.ComponentModel.RunWorkerCompletedEventArgs属性公开。 如果在 Visual Studio 调试器下运行，则调试器将在事件处理程序中 DoWork 引发未经处理的异常的点处中断。 如果有多个 BackgroundWorker，则不应直接引用其中的任何一个，因为这样会将事件处理程序耦合 DoWork 到 的特定实例 BackgroundWorker。 相反，应通过在事件处理程序中DoWork强制转换 sender 参数来访问 BackgroundWorker 。

必须注意不要在事件处理程序中 DoWork 操作任何用户界面对象。 而应该通过 BackgroundWorker 事件与用户界面进行通信。

有关如何处理事件的详细信息，请参阅 处理和引发事件。

另请参阅

• 如何：在后台运行操作
• 托管线程处理的最佳做法
• 如何：在后台下载文件