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