1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.ComponentModel.EventBasedAsync</name>
6 <member name="T:System.ComponentModel.ProgressChangedEventArgs">
7 <summary>Provides data for the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged"></see> event.</summary>
9 <member name="M:System.ComponentModel.ProgressChangedEventArgs.#ctor(System.Int32,System.Object)">
10 <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.ProgressChangedEventArgs"></see> class.</summary>
11 <param name="progressPercentage">The percentage of an asynchronous task that has been completed.</param>
12 <param name="userState">A unique user state.</param>
14 <member name="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage">
15 <summary>Gets the asynchronous task progress percentage.</summary>
16 <returns>A percentage value indicating the asynchronous task progress.</returns>
18 <member name="P:System.ComponentModel.ProgressChangedEventArgs.UserState">
19 <summary>Gets a unique user state.</summary>
20 <returns>A unique <see cref="System.Object"></see> indicating the user state.</returns>
22 <member name="T:System.ComponentModel.ProgressChangedEventHandler">
23 <summary>Represents the method that will handle the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged"></see> event of the <see cref="T:System.ComponentModel.BackgroundWorker"></see> class. This class cannot be inherited.</summary>
24 <param name="sender">The source of the event.</param>
25 <param name="e">A <see cref="T:System.ComponentModel.ProgressChangedEventArgs"></see> that contains the event data.</param>
27 <member name="T:System.ComponentModel.RunWorkerCompletedEventArgs">
28 <summary>Provides data for the MethodNameCompleted event.</summary>
30 <member name="M:System.ComponentModel.RunWorkerCompletedEventArgs.#ctor(System.Object,System.Exception,System.Boolean)">
31 <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.RunWorkerCompletedEventArgs"></see> class.</summary>
32 <param name="result">The result of an asynchronous operation.</param>
33 <param name="error">Any error that occurred during the asynchronous operation.</param>
34 <param name="cancelled">A value indicating whether the asynchronous operation was canceled.</param>
36 <member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.Result">
37 <summary>Gets a value that represents the result of an asynchronous operation.</summary>
38 <returns>An <see cref="System.Object"></see> representing the result of an asynchronous operation.</returns>
39 <exception cref="T:System.Reflection.TargetInvocationException"><see cref="System.ComponentModel.AsyncCompletedEventArgs.Error"></see> is not null. The <see cref="System.Exception.InnerException"></see> property holds a reference to <see cref="System.ComponentModel.AsyncCompletedEventArgs.Error"></see>.</exception>
40 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.AsyncCompletedEventArgs.Cancelled"></see> is true.</exception>
42 <member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.UserState">
43 <summary>Gets a value that represents the user state.</summary>
44 <returns>An <see cref="System.Object"></see> representing the user state.</returns>
46 <member name="T:System.ComponentModel.RunWorkerCompletedEventHandler">
47 <summary>Represents the method that will handle the <see cref="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted"></see> event of a <see cref="T:System.ComponentModel.BackgroundWorker"></see> class.</summary>
48 <param name="sender">The source of the event.</param>
49 <param name="e">A <see cref="T:System.ComponentModel.RunWorkerCompletedEventArgs"></see> that contains the event data.</param>
51 <member name="T:System.ComponentModel.AsyncCompletedEventArgs">
52 <summary>Provides data for the MethodNameCompleted event.</summary>
54 <member name="M:System.ComponentModel.AsyncCompletedEventArgs.#ctor(System.Exception,System.Boolean,System.Object)">
55 <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.AsyncCompletedEventArgs"></see> class.</summary>
56 <param name="error">Any error that occurred during the asynchronous operation.</param>
57 <param name="cancelled">A value indicating whether the asynchronous operation was canceled.</param>
58 <param name="userState">The optional user-supplied state object passed to the <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)"></see> method.</param>
60 <member name="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled">
61 <summary>Gets a value indicating whether an asynchronous operation has been canceled.</summary>
62 <returns>true if the background operation has been canceled; otherwise false. The default is false.</returns>
64 <member name="P:System.ComponentModel.AsyncCompletedEventArgs.Error">
65 <summary>Gets a value indicating which error occurred during an asynchronous operation.</summary>
66 <returns>An <see cref="System.Exception"></see> instance, if an error occurred during an asynchronous operation; otherwise null.</returns>
68 <member name="M:System.ComponentModel.AsyncCompletedEventArgs.RaiseExceptionIfNecessary">
69 <summary>Raises a user-supplied exception if an asynchronous operation failed.</summary>
70 <exception cref="T:System.InvalidOperationException">The <see cref="System.ComponentModel.AsyncCompletedEventArgs.Cancelled"></see> property is true.</exception>
71 <exception cref="T:System.Reflection.TargetInvocationException">The <see cref="System.ComponentModel.AsyncCompletedEventArgs.Error"></see> property has been set by the asynchronous operation. The <see cref="System.Exception.InnerException"></see> property holds a reference to <see cref="System.ComponentModel.AsyncCompletedEventArgs.Error"></see>.</exception>
73 <member name="P:System.ComponentModel.AsyncCompletedEventArgs.UserState">
74 <summary>Gets the unique identifier for the asynchronous task.</summary>
75 <returns>An object reference that uniquely identifies the asynchronous task; otherwise, null if no value has been set.</returns>
77 <member name="T:System.ComponentModel.AsyncCompletedEventHandler">
78 <summary>Represents the method that will handle the MethodNameCompleted event of an asynchronous operation.</summary>
79 <param name="sender">The source of the event.</param>
80 <param name="e">An <see cref="T:System.ComponentModel.AsyncCompletedEventArgs"></see> that contains the event data.</param>
82 <member name="T:System.ComponentModel.AsyncOperation">
83 <summary>Tracks the lifetime of an asynchronous operation.</summary>
85 <member name="M:System.ComponentModel.AsyncOperation.Finalize">
86 <summary>Finalizes the asynchronous operation.</summary>
88 <member name="M:System.ComponentModel.AsyncOperation.OperationCompleted">
89 <summary>Ends the lifetime of an asynchronous operation.</summary>
90 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.AsyncOperation.OperationCompleted"></see> has been called previously for this task.</exception>
92 <member name="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)">
93 <summary>Invokes a delegate on the thread or context appropriate for the application model.</summary>
94 <param name="d">A <see cref="T:System.Threading.SendOrPostCallback"></see> object that wraps the delegate to be called when the operation ends.</param>
95 <param name="arg">An argument for the delegate contained in the d parameter.</param>
96 <exception cref="T:System.InvalidOperationException">The <see cref="System.ComponentModel.AsyncOperation.PostOperationCompleted(System.Threading.SendOrPostCallback,System.Object)"></see> method has been called previously for this task.</exception>
97 <exception cref="T:System.ArgumentNullException"><paramref name="d">d</paramref> is null.</exception>
99 <member name="M:System.ComponentModel.AsyncOperation.PostOperationCompleted(System.Threading.SendOrPostCallback,System.Object)">
100 <summary>Ends the lifetime of an asynchronous operation.</summary>
101 <param name="d">A <see cref="T:System.Threading.SendOrPostCallback"></see> object that wraps the delegate to be called when the operation ends.</param>
102 <param name="arg">An argument for the delegate contained in the d parameter.</param>
103 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.AsyncOperation.OperationCompleted"></see> has been called previously for this task.</exception>
104 <exception cref="T:System.ArgumentNullException"><paramref name="d">d</paramref> is null.</exception>
106 <member name="P:System.ComponentModel.AsyncOperation.SynchronizationContext">
107 <summary>Gets the <see cref="T:System.Threading.SynchronizationContext"></see> object that was passed to the constructor.</summary>
108 <returns>The <see cref="System.Threading.SynchronizationContext"></see> object that was passed to the constructor.</returns>
110 <member name="P:System.ComponentModel.AsyncOperation.UserSuppliedState">
111 <summary>Gets or sets an object used to uniquely identify an asynchronous operation.</summary>
112 <returns>The state object passed to the asynchronous method invocation.</returns>
114 <member name="T:System.ComponentModel.AsyncOperationManager">
115 <summary>Provides concurrency management for classes that support asynchronous method calls. This class cannot be inherited.</summary>
117 <member name="M:System.ComponentModel.AsyncOperationManager.CreateOperation(System.Object)">
118 <summary>Returns an <see cref="T:System.ComponentModel.AsyncOperation"></see> for tracking the duration of a particular asynchronous operation.</summary>
119 <param name="userSuppliedState">An object used to associate a piece of client state, such as a task ID, with a particular asynchronous operation.</param>
120 <returns>An <see cref="System.ComponentModel.AsyncOperation"></see> that you can use to track the duration of an asynchronous method invocation.</returns>
122 <member name="P:System.ComponentModel.AsyncOperationManager.SynchronizationContext">
123 <summary>Gets or sets the synchronization context for the asynchronous operation.</summary>
124 <returns>The synchronization context for the asynchronous operation.</returns>
126 <member name="T:System.ComponentModel.BackgroundWorker">
127 <summary>Executes an operation on a separate thread.</summary>
129 <member name="M:System.ComponentModel.BackgroundWorker.#ctor">
130 <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.BackgroundWorker"></see> class.</summary>
132 <member name="M:System.ComponentModel.BackgroundWorker.CancelAsync">
133 <summary>Requests cancellation of a pending background operation.</summary>
134 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.BackgroundWorker.WorkerSupportsCancellation"></see> is false.</exception>
136 <member name="P:System.ComponentModel.BackgroundWorker.CancellationPending">
137 <summary>Gets a value indicating whether the application has requested cancellation of a background operation.</summary>
138 <returns>true if the application has requested cancellation of a background operation; otherwise, false. The default is false.</returns>
140 <member name="M:System.ComponentModel.BackgroundWorker.Dispose">
143 <member name="M:System.ComponentModel.BackgroundWorker.Dispose(System.Boolean)">
144 <param name="disposing"></param>
146 <member name="E:System.ComponentModel.BackgroundWorker.DoWork">
147 <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync"></see> is called.</summary>
149 <member name="P:System.ComponentModel.BackgroundWorker.IsBusy">
150 <summary>Gets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker"></see> is running an asynchronous operation.</summary>
151 <returns>true, if the <see cref="System.ComponentModel.BackgroundWorker"></see> is running an asynchronous operation; otherwise, false.</returns>
153 <member name="M:System.ComponentModel.BackgroundWorker.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
154 <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork"></see> event.</summary>
155 <param name="e">An <see cref="T:System.EventArgs"></see> that contains the event data.</param>
157 <member name="M:System.ComponentModel.BackgroundWorker.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">
158 <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged"></see> event.</summary>
159 <param name="e">An <see cref="T:System.EventArgs"></see> that contains the event data.</param>
161 <member name="M:System.ComponentModel.BackgroundWorker.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">
162 <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted"></see> event.</summary>
163 <param name="e">An <see cref="T:System.EventArgs"></see> that contains the event data.</param>
165 <member name="E:System.ComponentModel.BackgroundWorker.ProgressChanged">
166 <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)"></see> is called.</summary>
168 <member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)">
169 <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged"></see> event.</summary>
170 <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
171 <exception cref="T:System.InvalidOperationException">The <see cref="System.ComponentModel.BackgroundWorker.WorkerReportsProgress"></see> property is set to false.</exception>
173 <member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32,System.Object)">
174 <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged"></see> event.</summary>
175 <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
176 <param name="userState">The state object passed to <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)"></see>.</param>
177 <exception cref="T:System.InvalidOperationException">The <see cref="System.ComponentModel.BackgroundWorker.WorkerReportsProgress"></see> property is set to false.</exception>
179 <member name="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync">
180 <summary>Starts execution of a background operation.</summary>
181 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.BackgroundWorker.IsBusy"></see> is true.</exception>
183 <member name="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)">
184 <summary>Starts execution of a background operation.</summary>
185 <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork"></see> event handler.</param>
186 <exception cref="T:System.InvalidOperationException"><see cref="System.ComponentModel.BackgroundWorker.IsBusy"></see> is true.</exception>
188 <member name="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted">
189 <summary>Occurs when the background operation has completed, has been canceled, or has raised an exception.</summary>
191 <member name="P:System.ComponentModel.BackgroundWorker.WorkerReportsProgress">
192 <summary>Gets or sets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker"></see> can report progress updates.</summary>
193 <returns>true if the <see cref="System.ComponentModel.BackgroundWorker"></see> supports progress updates; otherwise false. The default is false.</returns>
195 <member name="P:System.ComponentModel.BackgroundWorker.WorkerSupportsCancellation">
196 <summary>Gets or sets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker"></see> supports asynchronous cancellation.</summary>
197 <returns>true if the <see cref="System.ComponentModel.BackgroundWorker"></see> supports cancellation; otherwise false. The default is false.</returns>
199 <member name="T:System.ComponentModel.DoWorkEventArgs">
200 <summary>Provides data for the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork"></see> event handler.</summary>
202 <member name="M:System.ComponentModel.DoWorkEventArgs.#ctor(System.Object)">
203 <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.DoWorkEventArgs"></see> class.</summary>
204 <param name="argument">Specifies an argument for an asynchronous operation.</param>
206 <member name="P:System.ComponentModel.DoWorkEventArgs.Argument">
207 <summary>Gets a value that represents the argument of an asynchronous operation.</summary>
208 <returns>An <see cref="System.Object"></see> representing the argument of an asynchronous operation.</returns>
210 <member name="P:System.ComponentModel.DoWorkEventArgs.Cancel">
213 <member name="P:System.ComponentModel.DoWorkEventArgs.Result">
214 <summary>Gets or sets a value that represents the result of an asynchronous operation.</summary>
215 <returns>An <see cref="System.Object"></see> representing the result of an asynchronous operation.</returns>
217 <member name="T:System.ComponentModel.DoWorkEventHandler">
218 <summary>Represents the method that will handle the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork"></see> event. This class cannot be inherited.</summary>
219 <param name="sender">The source of the event.</param>
220 <param name="e">A <see cref="T:System.ComponentModel.DoWorkEventArgs"></see> that contains the event data.</param>