875e232d2e69abb121008c0bfc1f21172884cdd0
[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="M:System.ComponentModel.AsyncCompletedEventArgs.RaiseExceptionIfNecessary">
17       <summary>Raises a user-supplied exception if an asynchronous operation failed.</summary>
18       <exception cref="T:System.InvalidOperationException">The <see cref="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled" /> property is <see langword="true" />.</exception>
19       <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>
20     </member>
21     <member name="P:System.ComponentModel.AsyncCompletedEventArgs.Cancelled">
22       <summary>Gets a value indicating whether an asynchronous operation has been canceled.</summary>
23       <returns>
24         <see langword="true" /> if the background operation has been canceled; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
25     </member>
26     <member name="P:System.ComponentModel.AsyncCompletedEventArgs.Error">
27       <summary>Gets a value indicating which error occurred during an asynchronous operation.</summary>
28       <returns>An <see cref="T:System.Exception" /> instance, if an error occurred during an asynchronous operation; otherwise <see langword="null" />.</returns>
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="E:System.ComponentModel.BackgroundWorker.DoWork">
91       <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync" /> is called.</summary>
92     </member>
93     <member name="E:System.ComponentModel.BackgroundWorker.ProgressChanged">
94       <summary>Occurs when <see cref="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)" /> is called.</summary>
95     </member>
96     <member name="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted">
97       <summary>Occurs when the background operation has completed, has been canceled, or has raised an exception.</summary>
98     </member>
99     <member name="M:System.ComponentModel.BackgroundWorker.#ctor">
100       <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.BackgroundWorker" /> class.</summary>
101     </member>
102     <member name="M:System.ComponentModel.BackgroundWorker.CancelAsync">
103       <summary>Requests cancellation of a pending background operation.</summary>
104       <exception cref="T:System.InvalidOperationException">
105         <see cref="P:System.ComponentModel.BackgroundWorker.WorkerSupportsCancellation" /> is <see langword="false" />.</exception>
106     </member>
107     <member name="M:System.ComponentModel.BackgroundWorker.Dispose(System.Boolean)">
108       <summary>This method does not do anything.</summary>
109       <param name="disposing">This method does not do anything.</param>
110     </member>
111     <member name="M:System.ComponentModel.BackgroundWorker.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
112       <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork" /> event.</summary>
113       <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
114     </member>
115     <member name="M:System.ComponentModel.BackgroundWorker.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">
116       <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
117       <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
118     </member>
119     <member name="M:System.ComponentModel.BackgroundWorker.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">
120       <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.RunWorkerCompleted" /> event.</summary>
121       <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
122     </member>
123     <member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)">
124       <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
125       <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
126       <exception cref="T:System.InvalidOperationException">The <see cref="P:System.ComponentModel.BackgroundWorker.WorkerReportsProgress" /> property is set to <see langword="false" />.</exception>
127     </member>
128     <member name="M:System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32,System.Object)">
129       <summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
130       <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
131       <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>
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.RunWorkerAsync">
135       <summary>Starts execution of a background operation.</summary>
136       <exception cref="T:System.InvalidOperationException">
137         <see cref="P:System.ComponentModel.BackgroundWorker.IsBusy" /> is <see langword="true" />.</exception>
138     </member>
139     <member name="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)">
140       <summary>Starts execution of a background operation.</summary>
141       <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>
142       <exception cref="T:System.InvalidOperationException">
143         <see cref="P:System.ComponentModel.BackgroundWorker.IsBusy" /> is <see langword="true" />.</exception>
144     </member>
145     <member name="P:System.ComponentModel.BackgroundWorker.CancellationPending">
146       <summary>Gets a value indicating whether the application has requested cancellation of a background operation.</summary>
147       <returns>
148         <see langword="true" /> if the application has requested cancellation of a background operation; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
149     </member>
150     <member name="P:System.ComponentModel.BackgroundWorker.IsBusy">
151       <summary>Gets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation.</summary>
152       <returns>
153         <see langword="true" />, if the <see cref="T:System.ComponentModel.BackgroundWorker" /> is running an asynchronous operation; otherwise, <see langword="false" />.</returns>
154     </member>
155     <member name="P:System.ComponentModel.BackgroundWorker.WorkerReportsProgress">
156       <summary>Gets or sets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> can report progress updates.</summary>
157       <returns>
158         <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>
159     </member>
160     <member name="P:System.ComponentModel.BackgroundWorker.WorkerSupportsCancellation">
161       <summary>Gets or sets a value indicating whether the <see cref="T:System.ComponentModel.BackgroundWorker" /> supports asynchronous cancellation.</summary>
162       <returns>
163         <see langword="true" /> if the <see cref="T:System.ComponentModel.BackgroundWorker" /> supports cancellation; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
164     </member>
165     <member name="T:System.ComponentModel.DoWorkEventArgs">
166       <summary>Provides data for the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork" /> event handler.</summary>
167     </member>
168     <member name="M:System.ComponentModel.DoWorkEventArgs.#ctor(System.Object)">
169       <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.DoWorkEventArgs" /> class.</summary>
170       <param name="argument">Specifies an argument for an asynchronous operation.</param>
171     </member>
172     <member name="P:System.ComponentModel.DoWorkEventArgs.Argument">
173       <summary>Gets a value that represents the argument of an asynchronous operation.</summary>
174       <returns>An <see cref="T:System.Object" /> representing the argument of an asynchronous operation.</returns>
175     </member>
176     <member name="P:System.ComponentModel.DoWorkEventArgs.Result">
177       <summary>Gets or sets a value that represents the result of an asynchronous operation.</summary>
178       <returns>An <see cref="T:System.Object" /> representing the result of an asynchronous operation.</returns>
179     </member>
180     <member name="T:System.ComponentModel.DoWorkEventHandler">
181       <summary>Represents the method that will handle the <see cref="E:System.ComponentModel.BackgroundWorker.DoWork" /> event. This class cannot be inherited.</summary>
182       <param name="sender">The source of the event.</param>
183       <param name="e">A <see cref="T:System.ComponentModel.DoWorkEventArgs" /> that contains the event data.</param>
184     </member>
185     <member name="T:System.ComponentModel.ProgressChangedEventArgs">
186       <summary>Provides data for the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
187     </member>
188     <member name="M:System.ComponentModel.ProgressChangedEventArgs.#ctor(System.Int32,System.Object)">
189       <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.ProgressChangedEventArgs" /> class.</summary>
190       <param name="progressPercentage">The percentage of an asynchronous task that has been completed.</param>
191       <param name="userState">A unique user state.</param>
192     </member>
193     <member name="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage">
194       <summary>Gets the asynchronous task progress percentage.</summary>
195       <returns>A percentage value indicating the asynchronous task progress.</returns>
196     </member>
197     <member name="P:System.ComponentModel.ProgressChangedEventArgs.UserState">
198       <summary>Gets a unique user state.</summary>
199       <returns>A unique <see cref="T:System.Object" /> indicating the user state.</returns>
200     </member>
201     <member name="T:System.ComponentModel.ProgressChangedEventHandler">
202       <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>
203       <param name="sender">The source of the event.</param>
204       <param name="e">A <see cref="T:System.ComponentModel.ProgressChangedEventArgs" /> that contains the event data.</param>
205     </member>
206     <member name="T:System.ComponentModel.RunWorkerCompletedEventArgs">
207       <summary>Provides data for the MethodName<see langword="Completed" /> event.</summary>
208     </member>
209     <member name="M:System.ComponentModel.RunWorkerCompletedEventArgs.#ctor(System.Object,System.Exception,System.Boolean)">
210       <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.RunWorkerCompletedEventArgs" /> class.</summary>
211       <param name="result">The result of an asynchronous operation.</param>
212       <param name="error">Any error that occurred during the asynchronous operation.</param>
213       <param name="cancelled">A value indicating whether the asynchronous operation was canceled.</param>
214     </member>
215     <member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.Result">
216       <summary>Gets a value that represents the result of an asynchronous operation.</summary>
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       <returns>An <see cref="T:System.Object" /> representing the result of an asynchronous operation.</returns>
222     </member>
223     <member name="P:System.ComponentModel.RunWorkerCompletedEventArgs.UserState">
224       <summary>Gets a value that represents the user state.</summary>
225       <returns>An <see cref="T:System.Object" /> representing the user state.</returns>
226     </member>
227     <member name="T:System.ComponentModel.RunWorkerCompletedEventHandler">
228       <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>
229       <param name="sender">The source of the event.</param>
230       <param name="e">A <see cref="T:System.ComponentModel.RunWorkerCompletedEventArgs" /> that contains the event data.</param>
231     </member>
232   </members>
233 </doc>