RunWorkerCompletedEventArgs Class
![]() |
---|
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience. |
Provides data for the MethodNameCompleted event.
Assembly: System (in System.dll)
System.EventArgs
System.ComponentModel.AsyncCompletedEventArgs
System.ComponentModel.RunWorkerCompletedEventArgs
Name | Description | |
---|---|---|
![]() | RunWorkerCompletedEventArgs(Object, Exception, Boolean) | Initializes a new instance of the RunWorkerCompletedEventArgs class. |
Name | Description | |
---|---|---|
![]() | Cancelled | Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.) |
![]() | Error | Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.) |
![]() | Result | Gets a value that represents the result of an asynchronous operation. |
![]() | UserState | Gets a value that represents the user state. |
Name | Description | |
---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | RaiseExceptionIfNecessary() | Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.) |
![]() | ToString() | 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) { MessageBox.Show(e.Error.Message); } 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"; } else { // 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; }
Available since 10
.NET Framework
Available since 2.0
Silverlight
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.