DoWorkEventArgs Class

Definition

public ref class DoWorkEventArgs : EventArgs

public ref class DoWorkEventArgs : System::ComponentModel::CancelEventArgs

public class DoWorkEventArgs : EventArgs

public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs

type DoWorkEventArgs = class
 inherit EventArgs

type DoWorkEventArgs = class
 inherit CancelEventArgs

Public Class DoWorkEventArgs
Inherits EventArgs

Public Class DoWorkEventArgs
Inherits CancelEventArgs

Inheritance

Object

EventArgs

DoWorkEventArgs

Inheritance

Object

EventArgs

CancelEventArgs

DoWorkEventArgs

Examples

The following code example demonstrates how to use the DoWorkEventArgs class to handle the DoWork event. For a full code listing, see How to: Run an Operation in the Background.

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

See also

• BackgroundWorker
• How to: Run an Operation in the Background