DoWorkEventArgs.Argument Property

Definition

Namespace:

System.ComponentModel

Assemblies:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Source:

DoWorkEvent.cs

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

C#

public object? Argument { get; }

Property Value

Object

An Object representing the argument of an asynchronous operation.

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.

C#

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

Applies to

See also

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