Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

DoWorkEventArgs.Argument Property

Gets a value that represents the argument of an asynchronous operation.

Namespace:  System.ComponentModel
Assemblies:   System (in System.dll)
  System.ComponentModel.EventBasedAsync (in System.ComponentModel.EventBasedAsync.dll)

public Object Argument { get; }

Property Value

Type: System.Object
An Object representing the argument of an asynchronous operation.

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.

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;
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft