RunWorkerCompletedEventArgs Class
Collapse the table of content
Expand the table of content

RunWorkerCompletedEventArgs Class


Provides data for the MethodNameCompleted event.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)


[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class RunWorkerCompletedEventArgs : AsyncCompletedEventArgs

System_CAPS_pubmethodRunWorkerCompletedEventArgs(Object, Exception, Boolean)

Initializes a new instance of the RunWorkerCompletedEventArgs class.


Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.)


Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.)


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


Gets a value that represents the user state.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.)


Returns a string that represents the current object.(Inherited from Object.)

If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class provides a MethodNameCompleted event. MethodName is a placeholder for the first part of the method's name. BackgroundWorker.OnRunWorkerCompleted is an example of the name of such a method. If you add an instance of the RunWorkerCompletedEventArgs delegate to the event, you will receive information about the outcome of asynchronous operations in the RunWorkerCompletedEventArgs parameter of the corresponding event handler.


The HostProtectionAttribute attribute applied to this class has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example illustrates the use of RunWorkerCompletedEventArgs. This example is part of a larger sample for the BackgroundWorker class.

// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    else if (e.Cancelled)
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();

    // Enable the UpDown control.
    this.numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft