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