<param name="cancelled">A value indicating whether the asynchronous operation was canceled.</param>
<param name="userState">The optional user-supplied state object passed to the <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)" /> method.</param>
</member>
- <member name="M:System.ComponentModel.AsyncCompletedEventArgs.RaiseExceptionIfNecessary">
- <summary>Raises a user-supplied exception if an asynchronous operation failed.</summary>
- <exception cref="T:System.InvalidOperationException">The <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled" /> property is <see langword="true" />.</exception>
- <exception cref="T:System.Reflection.TargetInvocationException">The <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" /> property has been set by the asynchronous operation. The <see cref="P:System.Exception.InnerException" /> property holds a reference to <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" />.</exception>
- </member>
<member name="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled">
<summary>Gets a value indicating whether an asynchronous operation has been canceled.</summary>
<returns>
<summary>Gets a value indicating which error occurred during an asynchronous operation.</summary>
<returns>An <see cref="T:System.Exception" /> instance, if an error occurred during an asynchronous operation; otherwise <see langword="null" />.</returns>
</member>
+ <member name="M:System.ComponentModel.AsyncCompletedEventArgs.RaiseExceptionIfNecessary">
+ <summary>Raises a user-supplied exception if an asynchronous operation failed.</summary>
+ <exception cref="T:System.InvalidOperationException">The <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled" /> property is <see langword="true" />.</exception>
+ <exception cref="T:System.Reflection.TargetInvocationException">The <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" /> property has been set by the asynchronous operation. The <see cref="P:System.Exception.InnerException" /> property holds a reference to <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" />.</exception>
+ </member>
<member name="P:System.ComponentModel.AsyncCompletedEventArgs.UserState">
<summary>Gets the unique identifier for the asynchronous task.</summary>
<returns>An object reference that uniquely identifies the asynchronous task; otherwise, <see langword="null" /> if no value has been set.</returns>
<member name="T:System.ComponentModel.BackgroundWorker">
<summary>Executes an operation on a separate thread.</summary>
</member>
- <member name="E:System.ComponentModel.BackgroundWorker.DoWork">
- <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync" /> is called.</summary>
- </member>
- <member name="E:System.ComponentModel.BackgroundWorker.ProgressChanged">
- <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)" /> is called.</summary>
- </member>
- <member name="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted">
- <summary>Occurs when the background operation has completed, has been canceled, or has raised an exception.</summary>
- </member>
<member name="M:System.ComponentModel.BackgroundWorker.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.BackgroundWorker" /> class.</summary>
</member>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.ComponentModel.BackgroundWorker.WorkerSupportsCancellation" /> is <see langword="false" />.</exception>
</member>
+ <member name="P:System.ComponentModel.BackgroundWorker.CancellationPending">
+ <summary>Gets a value indicating whether the application has requested cancellation of a background operation.</summary>
+ <returns>
+ <see langword="true" /> if the application has requested cancellation of a background operation; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
+ </member>
<member name="M:System.ComponentModel.BackgroundWorker.Dispose(System.Boolean)">
- <summary>This method does not do anything.</summary>
- <param name="disposing">This method does not do anything.</param>
+ <param name="disposing" />
+ </member>
+ <member name="E:System.ComponentModel.BackgroundWorker.DoWork">
+ <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync" /> is called.</summary>
+ </member>
+ <member name="P:System.ComponentModel.BackgroundWorker.IsBusy">
+ <summary>Gets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation.</summary>
+ <returns>
+ <see langword="true" />, if the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.ComponentModel.BackgroundWorker.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
<summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork" /> event.</summary>
<summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted" /> event.</summary>
<param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
</member>
+ <member name="E:System.ComponentModel.BackgroundWorker.ProgressChanged">
+ <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)" /> is called.</summary>
+ </member>
<member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)">
<summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
<param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
<member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32,System.Object)">
<summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
<param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
- <param name="userState">A unique <see cref="T:System.Object" /> indicating the user state. Returned as the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.UserState" /> property of the <see cref="T:System.ComponentModel.ProgressChangedEventArgs" />.</param>
+ <param name="userState">The state object passed to <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)" />.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.ComponentModel.BackgroundWorker.WorkerReportsProgress" /> property is set to <see langword="false" />.</exception>
</member>
<member name="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync">
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.ComponentModel.BackgroundWorker.IsBusy" /> is <see langword="true" />.</exception>
</member>
- <member name="P:System.ComponentModel.BackgroundWorker.CancellationPending">
- <summary>Gets a value indicating whether the application has requested cancellation of a background operation.</summary>
- <returns>
- <see langword="true" /> if the application has requested cancellation of a background operation; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
- </member>
- <member name="P:System.ComponentModel.BackgroundWorker.IsBusy">
- <summary>Gets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation.</summary>
- <returns>
- <see langword="true" />, if the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation; otherwise, <see langword="false" />.</returns>
+ <member name="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted">
+ <summary>Occurs when the background operation has completed, has been canceled, or has raised an exception.</summary>
</member>
<member name="P:System.ComponentModel.BackgroundWorker.WorkerReportsProgress">
<summary>Gets or sets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> can report progress updates.</summary>
</member>
<member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.Result">
<summary>Gets a value that represents the result of an asynchronous operation.</summary>
+ <returns>An <see cref="T:System.Object" /> representing the result of an asynchronous operation.</returns>
<exception cref="T:System.Reflection.TargetInvocationException">
<see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" /> is not <see langword="null" />. The <see cref="P:System.Exception.InnerException" /> property holds a reference to <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Error" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled" /> is <see langword="true" />.</exception>
- <returns>An <see cref="T:System.Object" /> representing the result of an asynchronous operation.</returns>
</member>
<member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.UserState">
<summary>Gets a value that represents the user state.</summary>