BackgroundWorker.DoWork BackgroundWorker.DoWork BackgroundWorker.DoWork BackgroundWorker.DoWork Event

Определение

Возникает при вызове метода RunWorkerAsync().Occurs when RunWorkerAsync() is called.

public:
 event System::ComponentModel::DoWorkEventHandler ^ DoWork;
public event System.ComponentModel.DoWorkEventHandler DoWork;
member this.DoWork : System.ComponentModel.DoWorkEventHandler 
Public Custom Event DoWork As DoWorkEventHandler 

Примеры

В следующем примере кода показано использование DoWork события для запуска асинхронной операции.The following code example demonstrates the use of the DoWork event to start an asynchronous operation. Этот пример кода является частью большого примера, BackgroundWorker приведенного для класса.This code example is part of a larger example provided for the BackgroundWorker class.

// 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 метода.This event is raised when you call the RunWorkerAsync method. Здесь вы запускаете операцию, которая выполняет потенциально длительную работу.This is where you start the operation that performs the potentially time-consuming work.

Код в DoWork обработчике событий должен периодически CancellationPending проверять значение свойства и прерывать операцию, если это так true.Your code in the DoWork event handler should periodically check the CancellationPending property value and abort the operation if it is true. В Cancel этом случае можно установить System.ComponentModel.DoWorkEventArgs флаг trueв значение, а Cancelled флаг System.ComponentModel.RunWorkerCompletedEventArgs в RunWorkerCompleted обработчике событий будет установлен в trueзначение.When this occurs, you can set the Cancel flag of System.ComponentModel.DoWorkEventArgs to true, and the Cancelled flag of System.ComponentModel.RunWorkerCompletedEventArgs in your RunWorkerCompleted event handler will be set to true.

Внимание!

Имейте в виду, что код в DoWork обработчике событий может завершить свою работу в ходе выполнения запроса на отмену, а для trueцикла опроса может CancellationPending быть пропущено значение.Be aware that your code in the DoWork event handler may finish its work as a cancellation request is being made, and your polling loop may miss CancellationPending being set to true. В Cancelled этом случае System.ComponentModel.RunWorkerCompletedEventArgs флаг в RunWorkerCompleted обработчике событий не будет установлен в trueзначение, даже если был сделан запрос на отмену.In this case, the Cancelled flag of System.ComponentModel.RunWorkerCompletedEventArgs in your RunWorkerCompleted event handler will not be set to true, even though a cancellation request was made. Такая ситуация называется состоянием гонки и является распространенной проблемой в многопоточном программировании.This situation is called a race condition and is a common concern in multithreaded programming. Дополнительные сведения о проблемах многопоточной разработки см. в разделе рекомендации по работе с потоками.For more information about multithreading design issues, see Managed Threading Best Practices.

Если операция дает результат, можно присвоить результат DoWorkEventArgs.Result свойству.If your operation produces a result, you can assign the result to the DoWorkEventArgs.Result property. Он будет доступен для RunWorkerCompleted обработчика событий RunWorkerCompletedEventArgs.Result в свойстве.This will be available to the RunWorkerCompleted event handler in the RunWorkerCompletedEventArgs.Result property.

Если операция создает исключение, BackgroundWorker которое не обрабатывается кодом, то перехватывает исключение и передает его RunWorkerCompleted в обработчик событий, где Error он предоставляется как свойство объекта System.ComponentModel.RunWorkerCompletedEventArgs.If the operation raises an exception that your code does not handle, the BackgroundWorker catches the exception and passes it into the RunWorkerCompleted event handler, where it is exposed as the Error property of System.ComponentModel.RunWorkerCompletedEventArgs. Если вы используете отладчик Visual Studio, отладчик будет разрываться в точке DoWork обработчика событий, где возникло необработанное исключение.If you are running under the Visual Studio debugger, the debugger will break at the point in the DoWork event handler where the unhandled exception was raised. Если у вас несколько BackgroundWorker, не следует ссылаться ни на один из них напрямую, так как это приведет BackgroundWorkerк DoWork взаимосвязанию обработчика событий с конкретным экземпляром.If you have more than one BackgroundWorker, you should not reference any of them directly, as this would couple your DoWork event handler to a specific instance of BackgroundWorker. Вместо этого необходимо получить доступ BackgroundWorker , sender приведя параметр в DoWork обработчике событий.Instead, you should access your BackgroundWorker by casting the sender parameter in your DoWork event handler.

Необходимо следить за тем, чтобы не манипулировать объектами пользовательского интерфейса в DoWork обработчике событий.You must be careful not to manipulate any user-interface objects in your DoWork event handler. Вместо этого следует взаимодействовать с пользовательским интерфейсом BackgroundWorker через события.Instead, communicate to the user interface through the BackgroundWorker events.

Дополнительные сведения об обработке событий см. в разделе обработка и вызов событий.For more information about how to handle events, see Handling and Raising Events.

Применяется к

Дополнительно