This documentation is archived and is not being maintained.

BackgroundWorker Members

Executes an operation on a separate thread.

The BackgroundWorker type exposes the following members.

Public method BackgroundWorker Initializes a new instance of the BackgroundWorker class.

Public method CancelAsync Requests cancellation of a pending background operation.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose Overloaded. Releases the resources used by the Component.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone Overloaded.
Protected method OnDoWork Raises the DoWork event.
Protected method OnProgressChanged Raises the ProgressChanged event.
Protected method OnRunWorkerCompleted Raises the RunWorkerCompleted event.
Public method ReportProgress Overloaded. Raises the ProgressChanged event.
Public method RunWorkerAsync Overloaded. Starts execution of a background operation.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Public property CancellationPending Gets a value indicating whether the application has requested cancellation of a background operation.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property IsBusy Gets a value indicating whether the BackgroundWorker is running an asynchronous operation.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property WorkerReportsProgress Gets or sets a value indicating whether the BackgroundWorker can report progress updates.
Public property WorkerSupportsCancellation Gets or sets a value indicating whether the BackgroundWorker supports asynchronous cancellation.

Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event DoWork Occurs when RunWorkerAsync is called.
Public event ProgressChanged Occurs when ReportProgress is called.
Public event RunWorkerCompleted Occurs when the background operation has completed, has been canceled, or has raised an exception.