Mercurial > silverbladetech
comparison SSRS/Libs/GalaSoft.MvvmLight.SL5/GalaSoft.MvvmLight.SL5.XML @ 112:b9d5f934cb21
Initial upload
author | adminsh@apollo |
---|---|
date | Sat, 19 May 2012 16:09:07 +0100 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
111:6cb8cd05ad6b | 112:b9d5f934cb21 |
---|---|
1 <?xml version="1.0"?> | |
2 <doc> | |
3 <assembly> | |
4 <name>GalaSoft.MvvmLight.SL5</name> | |
5 </assembly> | |
6 <members> | |
7 <member name="T:GalaSoft.MvvmLight.ICleanup"> | |
8 <summary> | |
9 Defines a common interface for classes that should be cleaned up, | |
10 but without the implications that IDisposable presupposes. An instance | |
11 implementing ICleanup can be cleaned up without being | |
12 disposed and garbage collected. | |
13 </summary> | |
14 </member> | |
15 <member name="M:GalaSoft.MvvmLight.ICleanup.Cleanup"> | |
16 <summary> | |
17 Cleans up the instance, for example by saving its state, | |
18 removing resources, etc... | |
19 </summary> | |
20 </member> | |
21 <member name="T:GalaSoft.MvvmLight.Threading.DispatcherHelper"> | |
22 <summary> | |
23 Helper class for dispatcher operations on the UI thread. | |
24 </summary> | |
25 </member> | |
26 <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)"> | |
27 <summary> | |
28 Executes an action on the UI thread. If this method is called | |
29 from the UI thread, the action is executed immendiately. If the | |
30 method is called from another thread, the action will be enqueued | |
31 on the UI thread's dispatcher and executed asynchronously. | |
32 <para>For additional operations on the UI thread, you can get a | |
33 reference to the UI thread's dispatcher thanks to the property | |
34 <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/></para>. | |
35 </summary> | |
36 <param name="action">The action that will be executed on the UI | |
37 thread.</param> | |
38 </member> | |
39 <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"> | |
40 <summary> | |
41 This method should be called once on the UI thread to ensure that | |
42 the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/> property is initialized. | |
43 <para>In a Silverlight application, call this method in the | |
44 Application_Startup event handler, after the MainPage is constructed.</para> | |
45 <para>In WPF, call this method on the static App() constructor.</para> | |
46 </summary> | |
47 </member> | |
48 <member name="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"> | |
49 <summary> | |
50 Gets a reference to the UI thread's dispatcher, after the | |
51 <see cref="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"/> method has been called on the UI thread. | |
52 </summary> | |
53 </member> | |
54 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessage"> | |
55 <summary> | |
56 Passes a string message (Notification) to a recipient. | |
57 <para>Typically, notifications are defined as unique strings in a static class. To define | |
58 a unique string, you can use Guid.NewGuid().ToString() or any other unique | |
59 identifier.</para> | |
60 </summary> | |
61 </member> | |
62 <member name="T:GalaSoft.MvvmLight.Messaging.MessageBase"> | |
63 <summary> | |
64 Base class for all messages broadcasted by the Messenger. | |
65 You can create your own message types by extending this class. | |
66 </summary> | |
67 </member> | |
68 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor"> | |
69 <summary> | |
70 Initializes a new instance of the MessageBase class. | |
71 </summary> | |
72 </member> | |
73 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor(System.Object)"> | |
74 <summary> | |
75 Initializes a new instance of the MessageBase class. | |
76 </summary> | |
77 <param name="sender">The message's original sender.</param> | |
78 </member> | |
79 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor(System.Object,System.Object)"> | |
80 <summary> | |
81 Initializes a new instance of the MessageBase class. | |
82 </summary> | |
83 <param name="sender">The message's original sender.</param> | |
84 <param name="target">The message's intended target. This parameter can be used | |
85 to give an indication as to whom the message was intended for. Of course | |
86 this is only an indication, amd may be null.</param> | |
87 </member> | |
88 <member name="P:GalaSoft.MvvmLight.Messaging.MessageBase.Sender"> | |
89 <summary> | |
90 Gets or sets the message's sender. | |
91 </summary> | |
92 </member> | |
93 <member name="P:GalaSoft.MvvmLight.Messaging.MessageBase.Target"> | |
94 <summary> | |
95 Gets or sets the message's intended target. This property can be used | |
96 to give an indication as to whom the message was intended for. Of course | |
97 this is only an indication, amd may be null. | |
98 </summary> | |
99 </member> | |
100 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.String)"> | |
101 <summary> | |
102 Initializes a new instance of the NotificationMessage class. | |
103 </summary> | |
104 <param name="notification">A string containing any arbitrary message to be | |
105 passed to recipient(s)</param> | |
106 </member> | |
107 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.Object,System.String)"> | |
108 <summary> | |
109 Initializes a new instance of the NotificationMessage class. | |
110 </summary> | |
111 <param name="sender">The message's sender.</param> | |
112 <param name="notification">A string containing any arbitrary message to be | |
113 passed to recipient(s)</param> | |
114 </member> | |
115 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.Object,System.Object,System.String)"> | |
116 <summary> | |
117 Initializes a new instance of the NotificationMessage class. | |
118 </summary> | |
119 <param name="sender">The message's sender.</param> | |
120 <param name="target">The message's intended target. This parameter can be used | |
121 to give an indication as to whom the message was intended for. Of course | |
122 this is only an indication, amd may be null.</param> | |
123 <param name="notification">A string containing any arbitrary message to be | |
124 passed to recipient(s)</param> | |
125 </member> | |
126 <member name="P:GalaSoft.MvvmLight.Messaging.NotificationMessage.Notification"> | |
127 <summary> | |
128 Gets a string containing any arbitrary message to be | |
129 passed to recipient(s). | |
130 </summary> | |
131 </member> | |
132 <member name="T:GalaSoft.MvvmLight.Helpers.WeakFunc`1"> | |
133 <summary> | |
134 Stores a Func<T> without causing a hard reference | |
135 to be created to the Func's owner. The owner can be garbage collected at any time. | |
136 </summary> | |
137 </member> | |
138 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`1.#ctor"> | |
139 <summary> | |
140 Initializes an empty instance of the WeakFunc class. | |
141 </summary> | |
142 </member> | |
143 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`1.#ctor(System.Func{`0})"> | |
144 <summary> | |
145 Initializes a new instance of the WeakFunc class. | |
146 </summary> | |
147 <param name="func">The func that will be associated to this instance.</param> | |
148 </member> | |
149 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`1.#ctor(System.Object,System.Func{`0})"> | |
150 <summary> | |
151 Initializes a new instance of the WeakFunc class. | |
152 </summary> | |
153 <param name="target">The func's owner.</param> | |
154 <param name="func">The func that will be associated to this instance.</param> | |
155 </member> | |
156 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Execute"> | |
157 <summary> | |
158 Executes the action. This only happens if the func's owner | |
159 is still alive. | |
160 </summary> | |
161 </member> | |
162 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`1.MarkForDeletion"> | |
163 <summary> | |
164 Sets the reference that this instance stores to null. | |
165 </summary> | |
166 </member> | |
167 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Method"> | |
168 <summary> | |
169 Gets or sets the <see cref="T:System.Reflection.MethodInfo"/> corresponding to this WeakFunc's | |
170 method passed in the constructor. | |
171 </summary> | |
172 </member> | |
173 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.MethodName"> | |
174 <summary> | |
175 Gets the name of the method that this WeakFunc represents. | |
176 </summary> | |
177 </member> | |
178 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.FuncReference"> | |
179 <summary> | |
180 Gets or sets a WeakReference to this WeakFunc's action's target. | |
181 This is not necessarily the same as | |
182 <see cref="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Reference"/>, for example if the | |
183 method is anonymous. | |
184 </summary> | |
185 </member> | |
186 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Reference"> | |
187 <summary> | |
188 Gets or sets a WeakReference to the target passed when constructing | |
189 the WeakFunc. This is not necessarily the same as | |
190 <see cref="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.FuncReference"/>, for example if the | |
191 method is anonymous. | |
192 </summary> | |
193 </member> | |
194 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.IsAlive"> | |
195 <summary> | |
196 Gets a value indicating whether the Func's owner is still alive, or if it was collected | |
197 by the Garbage Collector already. | |
198 </summary> | |
199 </member> | |
200 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Target"> | |
201 <summary> | |
202 Gets the Func's owner. This object is stored as a | |
203 <see cref="T:System.WeakReference"/>. | |
204 </summary> | |
205 </member> | |
206 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.FuncTarget"> | |
207 <summary> | |
208 Gets the owner of the Func that was passed as parameter. | |
209 This is not necessarily the same as | |
210 <see cref="P:GalaSoft.MvvmLight.Helpers.WeakFunc`1.Target"/>, for example if the | |
211 method is anonymous. | |
212 </summary> | |
213 </member> | |
214 <member name="T:GalaSoft.MvvmLight.Helpers.WeakAction"> | |
215 <summary> | |
216 Stores an <see cref="T:System.Action"/> without causing a hard reference | |
217 to be created to the Action's owner. The owner can be garbage collected at any time. | |
218 </summary> | |
219 </member> | |
220 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.#ctor"> | |
221 <summary> | |
222 Initializes an empty instance of the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakAction"/> class. | |
223 </summary> | |
224 </member> | |
225 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.#ctor(System.Action)"> | |
226 <summary> | |
227 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakAction"/> class. | |
228 </summary> | |
229 <param name="action">The action that will be associated to this instance.</param> | |
230 </member> | |
231 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.#ctor(System.Object,System.Action)"> | |
232 <summary> | |
233 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakAction"/> class. | |
234 </summary> | |
235 <param name="target">The action's owner.</param> | |
236 <param name="action">The action that will be associated to this instance.</param> | |
237 </member> | |
238 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.Execute"> | |
239 <summary> | |
240 Executes the action. This only happens if the action's owner | |
241 is still alive. | |
242 </summary> | |
243 </member> | |
244 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.MarkForDeletion"> | |
245 <summary> | |
246 Sets the reference that this instance stores to null. | |
247 </summary> | |
248 </member> | |
249 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.Method"> | |
250 <summary> | |
251 Gets or sets the <see cref="T:System.Reflection.MethodInfo"/> corresponding to this WeakAction's | |
252 method passed in the constructor. | |
253 </summary> | |
254 </member> | |
255 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.MethodName"> | |
256 <summary> | |
257 Gets the name of the method that this WeakAction represents. | |
258 </summary> | |
259 </member> | |
260 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.ActionReference"> | |
261 <summary> | |
262 Gets or sets a WeakReference to this WeakAction's action's target. | |
263 This is not necessarily the same as | |
264 <see cref="P:GalaSoft.MvvmLight.Helpers.WeakAction.Reference"/>, for example if the | |
265 method is anonymous. | |
266 </summary> | |
267 </member> | |
268 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.Reference"> | |
269 <summary> | |
270 Gets or sets a WeakReference to the target passed when constructing | |
271 the WeakAction. This is not necessarily the same as | |
272 <see cref="P:GalaSoft.MvvmLight.Helpers.WeakAction.ActionReference"/>, for example if the | |
273 method is anonymous. | |
274 </summary> | |
275 </member> | |
276 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.IsAlive"> | |
277 <summary> | |
278 Gets a value indicating whether the Action's owner is still alive, or if it was collected | |
279 by the Garbage Collector already. | |
280 </summary> | |
281 </member> | |
282 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.Target"> | |
283 <summary> | |
284 Gets the Action's owner. This object is stored as a | |
285 <see cref="T:System.WeakReference"/>. | |
286 </summary> | |
287 </member> | |
288 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.ActionTarget"> | |
289 <summary> | |
290 | |
291 </summary> | |
292 </member> | |
293 <member name="T:GalaSoft.MvvmLight.Helpers.WeakFunc`2"> | |
294 <summary> | |
295 Stores an Func without causing a hard reference | |
296 to be created to the Func's owner. The owner can be garbage collected at any time. | |
297 </summary> | |
298 <typeparam name="T">The type of the Func's parameter.</typeparam> | |
299 <typeparam name="TResult">The type of the Func's return value.</typeparam> | |
300 </member> | |
301 <member name="T:GalaSoft.MvvmLight.Helpers.IExecuteWithObjectAndResult"> | |
302 <summary> | |
303 This interface is meant for the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakFunc`1"/> class and can be | |
304 useful if you store multiple WeakFunc{T} instances but don't know in advance | |
305 what type T represents. | |
306 </summary> | |
307 </member> | |
308 <member name="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObjectAndResult.ExecuteWithObject(System.Object)"> | |
309 <summary> | |
310 Executes a func and returns the result. | |
311 </summary> | |
312 <param name="parameter">A parameter passed as an object, | |
313 to be casted to the appropriate type.</param> | |
314 </member> | |
315 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.#ctor(System.Func{`0,`1})"> | |
316 <summary> | |
317 Initializes a new instance of the WeakFunc class. | |
318 </summary> | |
319 <param name="func">The func that will be associated to this instance.</param> | |
320 </member> | |
321 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.#ctor(System.Object,System.Func{`0,`1})"> | |
322 <summary> | |
323 Initializes a new instance of the WeakFunc class. | |
324 </summary> | |
325 <param name="target">The func's owner.</param> | |
326 <param name="func">The func that will be associated to this instance.</param> | |
327 </member> | |
328 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.Execute"> | |
329 <summary> | |
330 Executes the func. This only happens if the func's owner | |
331 is still alive. The func's parameter is set to default(T). | |
332 </summary> | |
333 </member> | |
334 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.Execute(`0)"> | |
335 <summary> | |
336 Executes the func. This only happens if the func's owner | |
337 is still alive. | |
338 </summary> | |
339 <param name="parameter">A parameter to be passed to the action.</param> | |
340 </member> | |
341 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.ExecuteWithObject(System.Object)"> | |
342 <summary> | |
343 Executes the func with a parameter of type object. This parameter | |
344 will be casted to T. This method implements <see cref="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.ExecuteWithObject(System.Object)"/> | |
345 and can be useful if you store multiple WeakFunc{T} instances but don't know in advance | |
346 what type T represents. | |
347 </summary> | |
348 <param name="parameter">The parameter that will be passed to the func after | |
349 being casted to T.</param> | |
350 <returns>The result of the execution as object, to be casted to T.</returns> | |
351 </member> | |
352 <member name="M:GalaSoft.MvvmLight.Helpers.WeakFunc`2.MarkForDeletion"> | |
353 <summary> | |
354 Sets all the funcs that this WeakFunc contains to null, | |
355 which is a signal for containing objects that this WeakFunc | |
356 should be deleted. | |
357 </summary> | |
358 </member> | |
359 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`2.MethodName"> | |
360 <summary> | |
361 Gets or sets the name of the method that this WeakFunc represents. | |
362 </summary> | |
363 </member> | |
364 <member name="P:GalaSoft.MvvmLight.Helpers.WeakFunc`2.IsAlive"> | |
365 <summary> | |
366 Gets a value indicating whether the Func's owner is still alive, or if it was collected | |
367 by the Garbage Collector already. | |
368 </summary> | |
369 </member> | |
370 <member name="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"> | |
371 <summary> | |
372 Basis class for the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. This | |
373 class allows a recipient to register for all PropertyChangedMessages without | |
374 having to specify the type T. | |
375 </summary> | |
376 </member> | |
377 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.Object,System.String)"> | |
378 <summary> | |
379 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
380 </summary> | |
381 <param name="sender">The message's sender.</param> | |
382 <param name="propertyName">The name of the property that changed.</param> | |
383 </member> | |
384 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.Object,System.Object,System.String)"> | |
385 <summary> | |
386 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
387 </summary> | |
388 <param name="sender">The message's sender.</param> | |
389 <param name="target">The message's intended target. This parameter can be used | |
390 to give an indication as to whom the message was intended for. Of course | |
391 this is only an indication, amd may be null.</param> | |
392 <param name="propertyName">The name of the property that changed.</param> | |
393 </member> | |
394 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.String)"> | |
395 <summary> | |
396 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
397 </summary> | |
398 <param name="propertyName">The name of the property that changed.</param> | |
399 </member> | |
400 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.PropertyName"> | |
401 <summary> | |
402 Gets or sets the name of the property that changed. | |
403 </summary> | |
404 </member> | |
405 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"> | |
406 <summary> | |
407 Provides a message class with a built-in callback. When the recipient | |
408 is done processing the message, it can execute the callback to | |
409 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.Execute(`0)"/> | |
410 method to execute the callback. The callback method has one parameter. | |
411 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/>. | |
412 </summary> | |
413 <typeparam name="TCallbackParameter">The type of the callback method's | |
414 only parameter.</typeparam> | |
415 </member> | |
416 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"> | |
417 <summary> | |
418 Provides a message class with a built-in callback. When the recipient | |
419 is done processing the message, it can execute the callback to | |
420 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.Execute(System.Object[])"/> | |
421 method to execute the callback. The callback method has one parameter. | |
422 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> and | |
423 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/>. | |
424 </summary> | |
425 </member> | |
426 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.String,System.Delegate)"> | |
427 <summary> | |
428 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
429 </summary> | |
430 <param name="notification">An arbitrary string that will be | |
431 carried by the message.</param> | |
432 <param name="callback">The callback method that can be executed | |
433 by the recipient to notify the sender that the message has been | |
434 processed.</param> | |
435 </member> | |
436 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.Object,System.String,System.Delegate)"> | |
437 <summary> | |
438 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
439 </summary> | |
440 <param name="sender">The message's sender.</param> | |
441 <param name="notification">An arbitrary string that will be | |
442 carried by the message.</param> | |
443 <param name="callback">The callback method that can be executed | |
444 by the recipient to notify the sender that the message has been | |
445 processed.</param> | |
446 </member> | |
447 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.Object,System.Object,System.String,System.Delegate)"> | |
448 <summary> | |
449 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
450 </summary> | |
451 <param name="sender">The message's sender.</param> | |
452 <param name="target">The message's intended target. This parameter can be used | |
453 to give an indication as to whom the message was intended for. Of course | |
454 this is only an indication, amd may be null.</param> | |
455 <param name="notification">An arbitrary string that will be | |
456 carried by the message.</param> | |
457 <param name="callback">The callback method that can be executed | |
458 by the recipient to notify the sender that the message has been | |
459 processed.</param> | |
460 </member> | |
461 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.Execute(System.Object[])"> | |
462 <summary> | |
463 Executes the callback that was provided with the message with an | |
464 arbitrary number of parameters. | |
465 </summary> | |
466 <param name="arguments">A number of parameters that will | |
467 be passed to the callback method.</param> | |
468 <returns>The object returned by the callback method.</returns> | |
469 </member> | |
470 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.String,System.Action{`0})"> | |
471 <summary> | |
472 Initializes a new instance of the | |
473 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
474 </summary> | |
475 <param name="notification">An arbitrary string that will be | |
476 carried by the message.</param> | |
477 <param name="callback">The callback method that can be executed | |
478 by the recipient to notify the sender that the message has been | |
479 processed.</param> | |
480 </member> | |
481 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.Object,System.String,System.Action{`0})"> | |
482 <summary> | |
483 Initializes a new instance of the | |
484 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
485 </summary> | |
486 <param name="sender">The message's sender.</param> | |
487 <param name="notification">An arbitrary string that will be | |
488 carried by the message.</param> | |
489 <param name="callback">The callback method that can be executed | |
490 by the recipient to notify the sender that the message has been | |
491 processed.</param> | |
492 </member> | |
493 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.Object,System.Object,System.String,System.Action{`0})"> | |
494 <summary> | |
495 Initializes a new instance of the | |
496 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
497 </summary> | |
498 <param name="sender">The message's sender.</param> | |
499 <param name="target">The message's intended target. This parameter can be used | |
500 to give an indication as to whom the message was intended for. Of course | |
501 this is only an indication, amd may be null.</param> | |
502 <param name="notification">An arbitrary string that will be | |
503 carried by the message.</param> | |
504 <param name="callback">The callback method that can be executed | |
505 by the recipient to notify the sender that the message has been | |
506 processed.</param> | |
507 </member> | |
508 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.Execute(`0)"> | |
509 <summary> | |
510 Executes the callback that was provided with the message. | |
511 </summary> | |
512 <param name="parameter">A parameter requested by the message's | |
513 sender and providing additional information on the recipient's | |
514 state.</param> | |
515 </member> | |
516 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"> | |
517 <summary> | |
518 Provides a message class with a built-in callback. When the recipient | |
519 is done processing the message, it can execute the callback to | |
520 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.Execute"/> | |
521 method to execute the callback. | |
522 </summary> | |
523 </member> | |
524 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.String,System.Action)"> | |
525 <summary> | |
526 Initializes a new instance of the | |
527 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
528 </summary> | |
529 <param name="notification">An arbitrary string that will be | |
530 carried by the message.</param> | |
531 <param name="callback">The callback method that can be executed | |
532 by the recipient to notify the sender that the message has been | |
533 processed.</param> | |
534 </member> | |
535 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.Object,System.String,System.Action)"> | |
536 <summary> | |
537 Initializes a new instance of the | |
538 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
539 </summary> | |
540 <param name="sender">The message's sender.</param> | |
541 <param name="notification">An arbitrary string that will be | |
542 carried by the message.</param> | |
543 <param name="callback">The callback method that can be executed | |
544 by the recipient to notify the sender that the message has been | |
545 processed.</param> | |
546 </member> | |
547 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.Object,System.Object,System.String,System.Action)"> | |
548 <summary> | |
549 Initializes a new instance of the | |
550 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
551 </summary> | |
552 <param name="sender">The message's sender.</param> | |
553 <param name="target">The message's intended target. This parameter can be used | |
554 to give an indication as to whom the message was intended for. Of course | |
555 this is only an indication, amd may be null.</param> | |
556 <param name="notification">An arbitrary string that will be | |
557 carried by the message.</param> | |
558 <param name="callback">The callback method that can be executed | |
559 by the recipient to notify the sender that the message has been | |
560 processed.</param> | |
561 </member> | |
562 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.Execute"> | |
563 <summary> | |
564 Executes the callback that was provided with the message. | |
565 </summary> | |
566 </member> | |
567 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessage`1"> | |
568 <summary> | |
569 Passes a string message (Notification) and a generic value (Content) to a recipient. | |
570 </summary> | |
571 <typeparam name="T">The type of the Content property.</typeparam> | |
572 </member> | |
573 <member name="T:GalaSoft.MvvmLight.Messaging.GenericMessage`1"> | |
574 <summary> | |
575 Passes a generic value (Content) to a recipient. | |
576 </summary> | |
577 <typeparam name="T">The type of the Content property.</typeparam> | |
578 </member> | |
579 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(`0)"> | |
580 <summary> | |
581 Initializes a new instance of the GenericMessage class. | |
582 </summary> | |
583 <param name="content">The message content.</param> | |
584 </member> | |
585 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(System.Object,`0)"> | |
586 <summary> | |
587 Initializes a new instance of the GenericMessage class. | |
588 </summary> | |
589 <param name="sender">The message's sender.</param> | |
590 <param name="content">The message content.</param> | |
591 </member> | |
592 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(System.Object,System.Object,`0)"> | |
593 <summary> | |
594 Initializes a new instance of the GenericMessage class. | |
595 </summary> | |
596 <param name="sender">The message's sender.</param> | |
597 <param name="target">The message's intended target. This parameter can be used | |
598 to give an indication as to whom the message was intended for. Of course | |
599 this is only an indication, amd may be null.</param> | |
600 <param name="content">The message content.</param> | |
601 </member> | |
602 <member name="P:GalaSoft.MvvmLight.Messaging.GenericMessage`1.Content"> | |
603 <summary> | |
604 Gets or sets the message's content. | |
605 </summary> | |
606 </member> | |
607 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(`0,System.String)"> | |
608 <summary> | |
609 Initializes a new instance of the NotificationMessage class. | |
610 </summary> | |
611 <param name="content">A value to be passed to recipient(s).</param> | |
612 <param name="notification">A string containing any arbitrary message to be | |
613 passed to recipient(s)</param> | |
614 </member> | |
615 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(System.Object,`0,System.String)"> | |
616 <summary> | |
617 Initializes a new instance of the NotificationMessage class. | |
618 </summary> | |
619 <param name="sender">The message's sender.</param> | |
620 <param name="content">A value to be passed to recipient(s).</param> | |
621 <param name="notification">A string containing any arbitrary message to be | |
622 passed to recipient(s)</param> | |
623 </member> | |
624 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(System.Object,System.Object,`0,System.String)"> | |
625 <summary> | |
626 Initializes a new instance of the NotificationMessage class. | |
627 </summary> | |
628 <param name="sender">The message's sender.</param> | |
629 <param name="target">The message's intended target. This parameter can be used | |
630 to give an indication as to whom the message was intended for. Of course | |
631 this is only an indication, amd may be null.</param> | |
632 <param name="content">A value to be passed to recipient(s).</param> | |
633 <param name="notification">A string containing any arbitrary message to be | |
634 passed to recipient(s)</param> | |
635 </member> | |
636 <member name="P:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.Notification"> | |
637 <summary> | |
638 Gets a string containing any arbitrary message to be | |
639 passed to recipient(s). | |
640 </summary> | |
641 </member> | |
642 <member name="T:GalaSoft.MvvmLight.Helpers.WeakAction`1"> | |
643 <summary> | |
644 Stores an Action without causing a hard reference | |
645 to be created to the Action's owner. The owner can be garbage collected at any time. | |
646 </summary> | |
647 <typeparam name="T">The type of the Action's parameter.</typeparam> | |
648 </member> | |
649 <member name="T:GalaSoft.MvvmLight.Helpers.IExecuteWithObject"> | |
650 <summary> | |
651 This interface is meant for the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakAction`1"/> class and can be | |
652 useful if you store multiple WeakAction{T} instances but don't know in advance | |
653 what type T represents. | |
654 </summary> | |
655 </member> | |
656 <member name="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.ExecuteWithObject(System.Object)"> | |
657 <summary> | |
658 Executes an action. | |
659 </summary> | |
660 <param name="parameter">A parameter passed as an object, | |
661 to be casted to the appropriate type.</param> | |
662 </member> | |
663 <member name="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.MarkForDeletion"> | |
664 <summary> | |
665 Deletes all references, which notifies the cleanup method | |
666 that this entry must be deleted. | |
667 </summary> | |
668 </member> | |
669 <member name="P:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.Target"> | |
670 <summary> | |
671 The target of the WeakAction. | |
672 </summary> | |
673 </member> | |
674 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.#ctor(System.Action{`0})"> | |
675 <summary> | |
676 Initializes a new instance of the WeakAction class. | |
677 </summary> | |
678 <param name="action">The action that will be associated to this instance.</param> | |
679 </member> | |
680 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.#ctor(System.Object,System.Action{`0})"> | |
681 <summary> | |
682 Initializes a new instance of the WeakAction class. | |
683 </summary> | |
684 <param name="target">The action's owner.</param> | |
685 <param name="action">The action that will be associated to this instance.</param> | |
686 </member> | |
687 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.Execute"> | |
688 <summary> | |
689 Executes the action. This only happens if the action's owner | |
690 is still alive. The action's parameter is set to default(T). | |
691 </summary> | |
692 </member> | |
693 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.Execute(`0)"> | |
694 <summary> | |
695 Executes the action. This only happens if the action's owner | |
696 is still alive. | |
697 </summary> | |
698 <param name="parameter">A parameter to be passed to the action.</param> | |
699 </member> | |
700 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.ExecuteWithObject(System.Object)"> | |
701 <summary> | |
702 Executes the action with a parameter of type object. This parameter | |
703 will be casted to T. This method implements <see cref="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.ExecuteWithObject(System.Object)"/> | |
704 and can be useful if you store multiple WeakAction{T} instances but don't know in advance | |
705 what type T represents. | |
706 </summary> | |
707 <param name="parameter">The parameter that will be passed to the action after | |
708 being casted to T.</param> | |
709 </member> | |
710 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.MarkForDeletion"> | |
711 <summary> | |
712 Sets all the actions that this WeakAction contains to null, | |
713 which is a signal for containing objects that this WeakAction | |
714 should be deleted. | |
715 </summary> | |
716 </member> | |
717 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction`1.MethodName"> | |
718 <summary> | |
719 Gets the name of the method that this WeakAction represents. | |
720 </summary> | |
721 </member> | |
722 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction`1.IsAlive"> | |
723 <summary> | |
724 Gets a value indicating whether the Action's owner is still alive, or if it was collected | |
725 by the Garbage Collector already. | |
726 </summary> | |
727 </member> | |
728 <member name="T:GalaSoft.MvvmLight.Messaging.IMessenger"> | |
729 <summary> | |
730 The Messenger is a class allowing objects to exchange messages. | |
731 </summary> | |
732 </member> | |
733 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Register``1(System.Object,System.Action{``0})"> | |
734 <summary> | |
735 Registers a recipient for a type of message TMessage. The action | |
736 parameter will be executed when a corresponding message is sent. | |
737 <para>Registering a recipient does not create a hard reference to it, | |
738 so if this recipient is deleted, no memory leak is caused.</para> | |
739 </summary> | |
740 <typeparam name="TMessage">The type of message that the recipient registers | |
741 for.</typeparam> | |
742 <param name="recipient">The recipient that will receive the messages.</param> | |
743 <param name="action">The action that will be executed when a message | |
744 of type TMessage is sent.</param> | |
745 </member> | |
746 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Register``1(System.Object,System.Object,System.Action{``0})"> | |
747 <summary> | |
748 Registers a recipient for a type of message TMessage. | |
749 The action parameter will be executed when a corresponding | |
750 message is sent. See the receiveDerivedMessagesToo parameter | |
751 for details on how messages deriving from TMessage (or, if TMessage is an interface, | |
752 messages implementing TMessage) can be received too. | |
753 <para>Registering a recipient does not create a hard reference to it, | |
754 so if this recipient is deleted, no memory leak is caused.</para> | |
755 </summary> | |
756 <typeparam name="TMessage">The type of message that the recipient registers | |
757 for.</typeparam> | |
758 <param name="recipient">The recipient that will receive the messages.</param> | |
759 <param name="token">A token for a messaging channel. If a recipient registers | |
760 using a token, and a sender sends a message using the same token, then this | |
761 message will be delivered to the recipient. Other recipients who did not | |
762 use a token when registering (or who used a different token) will not | |
763 get the message. Similarly, messages sent without any token, or with a different | |
764 token, will not be delivered to that recipient.</param> | |
765 <param name="action">The action that will be executed when a message | |
766 of type TMessage is sent.</param> | |
767 </member> | |
768 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Register``1(System.Object,System.Object,System.Boolean,System.Action{``0})"> | |
769 <summary> | |
770 Registers a recipient for a type of message TMessage. | |
771 The action parameter will be executed when a corresponding | |
772 message is sent. See the receiveDerivedMessagesToo parameter | |
773 for details on how messages deriving from TMessage (or, if TMessage is an interface, | |
774 messages implementing TMessage) can be received too. | |
775 <para>Registering a recipient does not create a hard reference to it, | |
776 so if this recipient is deleted, no memory leak is caused.</para> | |
777 </summary> | |
778 <typeparam name="TMessage">The type of message that the recipient registers | |
779 for.</typeparam> | |
780 <param name="recipient">The recipient that will receive the messages.</param> | |
781 <param name="token">A token for a messaging channel. If a recipient registers | |
782 using a token, and a sender sends a message using the same token, then this | |
783 message will be delivered to the recipient. Other recipients who did not | |
784 use a token when registering (or who used a different token) will not | |
785 get the message. Similarly, messages sent without any token, or with a different | |
786 token, will not be delivered to that recipient.</param> | |
787 <param name="receiveDerivedMessagesToo">If true, message types deriving from | |
788 TMessage will also be transmitted to the recipient. For example, if a SendOrderMessage | |
789 and an ExecuteOrderMessage derive from OrderMessage, registering for OrderMessage | |
790 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
791 and ExecuteOrderMessage to the recipient that registered. | |
792 <para>Also, if TMessage is an interface, message types implementing TMessage will also be | |
793 transmitted to the recipient. For example, if a SendOrderMessage | |
794 and an ExecuteOrderMessage implement IOrderMessage, registering for IOrderMessage | |
795 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
796 and ExecuteOrderMessage to the recipient that registered.</para> | |
797 </param> | |
798 <param name="action">The action that will be executed when a message | |
799 of type TMessage is sent.</param> | |
800 </member> | |
801 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Register``1(System.Object,System.Boolean,System.Action{``0})"> | |
802 <summary> | |
803 Registers a recipient for a type of message TMessage. | |
804 The action parameter will be executed when a corresponding | |
805 message is sent. See the receiveDerivedMessagesToo parameter | |
806 for details on how messages deriving from TMessage (or, if TMessage is an interface, | |
807 messages implementing TMessage) can be received too. | |
808 <para>Registering a recipient does not create a hard reference to it, | |
809 so if this recipient is deleted, no memory leak is caused.</para> | |
810 </summary> | |
811 <typeparam name="TMessage">The type of message that the recipient registers | |
812 for.</typeparam> | |
813 <param name="recipient">The recipient that will receive the messages.</param> | |
814 <param name="receiveDerivedMessagesToo">If true, message types deriving from | |
815 TMessage will also be transmitted to the recipient. For example, if a SendOrderMessage | |
816 and an ExecuteOrderMessage derive from OrderMessage, registering for OrderMessage | |
817 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
818 and ExecuteOrderMessage to the recipient that registered. | |
819 <para>Also, if TMessage is an interface, message types implementing TMessage will also be | |
820 transmitted to the recipient. For example, if a SendOrderMessage | |
821 and an ExecuteOrderMessage implement IOrderMessage, registering for IOrderMessage | |
822 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
823 and ExecuteOrderMessage to the recipient that registered.</para> | |
824 </param> | |
825 <param name="action">The action that will be executed when a message | |
826 of type TMessage is sent.</param> | |
827 </member> | |
828 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Send``1(``0)"> | |
829 <summary> | |
830 Sends a message to registered recipients. The message will | |
831 reach all recipients that registered for this message type | |
832 using one of the Register methods. | |
833 </summary> | |
834 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
835 <param name="message">The message to send to registered recipients.</param> | |
836 </member> | |
837 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Send``2(``0)"> | |
838 <summary> | |
839 Sends a message to registered recipients. The message will | |
840 reach only recipients that registered for this message type | |
841 using one of the Register methods, and that are | |
842 of the targetType. | |
843 </summary> | |
844 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
845 <typeparam name="TTarget">The type of recipients that will receive | |
846 the message. The message won't be sent to recipients of another type.</typeparam> | |
847 <param name="message">The message to send to registered recipients.</param> | |
848 </member> | |
849 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Send``1(``0,System.Object)"> | |
850 <summary> | |
851 Sends a message to registered recipients. The message will | |
852 reach only recipients that registered for this message type | |
853 using one of the Register methods, and that are | |
854 of the targetType. | |
855 </summary> | |
856 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
857 <param name="message">The message to send to registered recipients.</param> | |
858 <param name="token">A token for a messaging channel. If a recipient registers | |
859 using a token, and a sender sends a message using the same token, then this | |
860 message will be delivered to the recipient. Other recipients who did not | |
861 use a token when registering (or who used a different token) will not | |
862 get the message. Similarly, messages sent without any token, or with a different | |
863 token, will not be delivered to that recipient.</param> | |
864 </member> | |
865 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Unregister(System.Object)"> | |
866 <summary> | |
867 Unregisters a messager recipient completely. After this method | |
868 is executed, the recipient will not receive any messages anymore. | |
869 </summary> | |
870 <param name="recipient">The recipient that must be unregistered.</param> | |
871 </member> | |
872 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Unregister``1(System.Object)"> | |
873 <summary> | |
874 Unregisters a message recipient for a given type of messages only. | |
875 After this method is executed, the recipient will not receive messages | |
876 of type TMessage anymore, but will still receive other message types (if it | |
877 registered for them previously). | |
878 </summary> | |
879 <typeparam name="TMessage">The type of messages that the recipient wants | |
880 to unregister from.</typeparam> | |
881 <param name="recipient">The recipient that must be unregistered.</param> | |
882 </member> | |
883 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Unregister``1(System.Object,System.Object)"> | |
884 <summary> | |
885 Unregisters a message recipient for a given type of messages only and for a given token. | |
886 After this method is executed, the recipient will not receive messages | |
887 of type TMessage anymore with the given token, but will still receive other message types | |
888 or messages with other tokens (if it registered for them previously). | |
889 </summary> | |
890 <param name="recipient">The recipient that must be unregistered.</param> | |
891 <param name="token">The token for which the recipient must be unregistered.</param> | |
892 <typeparam name="TMessage">The type of messages that the recipient wants | |
893 to unregister from.</typeparam> | |
894 </member> | |
895 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Unregister``1(System.Object,System.Action{``0})"> | |
896 <summary> | |
897 Unregisters a message recipient for a given type of messages and for | |
898 a given action. Other message types will still be transmitted to the | |
899 recipient (if it registered for them previously). Other actions that have | |
900 been registered for the message type TMessage and for the given recipient (if | |
901 available) will also remain available. | |
902 </summary> | |
903 <typeparam name="TMessage">The type of messages that the recipient wants | |
904 to unregister from.</typeparam> | |
905 <param name="recipient">The recipient that must be unregistered.</param> | |
906 <param name="action">The action that must be unregistered for | |
907 the recipient and for the message type TMessage.</param> | |
908 </member> | |
909 <member name="M:GalaSoft.MvvmLight.Messaging.IMessenger.Unregister``1(System.Object,System.Object,System.Action{``0})"> | |
910 <summary> | |
911 Unregisters a message recipient for a given type of messages, for | |
912 a given action and a given token. Other message types will still be transmitted to the | |
913 recipient (if it registered for them previously). Other actions that have | |
914 been registered for the message type TMessage, for the given recipient and other tokens (if | |
915 available) will also remain available. | |
916 </summary> | |
917 <typeparam name="TMessage">The type of messages that the recipient wants | |
918 to unregister from.</typeparam> | |
919 <param name="recipient">The recipient that must be unregistered.</param> | |
920 <param name="token">The token for which the recipient must be unregistered.</param> | |
921 <param name="action">The action that must be unregistered for | |
922 the recipient and for the message type TMessage.</param> | |
923 </member> | |
924 <member name="T:GalaSoft.MvvmLight.Messaging.Messenger"> | |
925 <summary> | |
926 The Messenger is a class allowing objects to exchange messages. | |
927 </summary> | |
928 </member> | |
929 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Register``1(System.Object,System.Action{``0})"> | |
930 <summary> | |
931 Registers a recipient for a type of message TMessage. The action | |
932 parameter will be executed when a corresponding message is sent. | |
933 <para>Registering a recipient does not create a hard reference to it, | |
934 so if this recipient is deleted, no memory leak is caused.</para> | |
935 </summary> | |
936 <typeparam name="TMessage">The type of message that the recipient registers | |
937 for.</typeparam> | |
938 <param name="recipient">The recipient that will receive the messages.</param> | |
939 <param name="action">The action that will be executed when a message | |
940 of type TMessage is sent.</param> | |
941 </member> | |
942 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Register``1(System.Object,System.Boolean,System.Action{``0})"> | |
943 <summary> | |
944 Registers a recipient for a type of message TMessage. | |
945 The action parameter will be executed when a corresponding | |
946 message is sent. See the receiveDerivedMessagesToo parameter | |
947 for details on how messages deriving from TMessage (or, if TMessage is an interface, | |
948 messages implementing TMessage) can be received too. | |
949 <para>Registering a recipient does not create a hard reference to it, | |
950 so if this recipient is deleted, no memory leak is caused.</para> | |
951 </summary> | |
952 <typeparam name="TMessage">The type of message that the recipient registers | |
953 for.</typeparam> | |
954 <param name="recipient">The recipient that will receive the messages.</param> | |
955 <param name="receiveDerivedMessagesToo">If true, message types deriving from | |
956 TMessage will also be transmitted to the recipient. For example, if a SendOrderMessage | |
957 and an ExecuteOrderMessage derive from OrderMessage, registering for OrderMessage | |
958 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
959 and ExecuteOrderMessage to the recipient that registered. | |
960 <para>Also, if TMessage is an interface, message types implementing TMessage will also be | |
961 transmitted to the recipient. For example, if a SendOrderMessage | |
962 and an ExecuteOrderMessage implement IOrderMessage, registering for IOrderMessage | |
963 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
964 and ExecuteOrderMessage to the recipient that registered.</para> | |
965 </param> | |
966 <param name="action">The action that will be executed when a message | |
967 of type TMessage is sent.</param> | |
968 </member> | |
969 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Register``1(System.Object,System.Object,System.Action{``0})"> | |
970 <summary> | |
971 Registers a recipient for a type of message TMessage. | |
972 The action parameter will be executed when a corresponding | |
973 message is sent. | |
974 <para>Registering a recipient does not create a hard reference to it, | |
975 so if this recipient is deleted, no memory leak is caused.</para> | |
976 </summary> | |
977 <typeparam name="TMessage">The type of message that the recipient registers | |
978 for.</typeparam> | |
979 <param name="recipient">The recipient that will receive the messages.</param> | |
980 <param name="token">A token for a messaging channel. If a recipient registers | |
981 using a token, and a sender sends a message using the same token, then this | |
982 message will be delivered to the recipient. Other recipients who did not | |
983 use a token when registering (or who used a different token) will not | |
984 get the message. Similarly, messages sent without any token, or with a different | |
985 token, will not be delivered to that recipient.</param> | |
986 <param name="action">The action that will be executed when a message | |
987 of type TMessage is sent.</param> | |
988 </member> | |
989 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Register``1(System.Object,System.Object,System.Boolean,System.Action{``0})"> | |
990 <summary> | |
991 Registers a recipient for a type of message TMessage. | |
992 The action parameter will be executed when a corresponding | |
993 message is sent. See the receiveDerivedMessagesToo parameter | |
994 for details on how messages deriving from TMessage (or, if TMessage is an interface, | |
995 messages implementing TMessage) can be received too. | |
996 <para>Registering a recipient does not create a hard reference to it, | |
997 so if this recipient is deleted, no memory leak is caused.</para> | |
998 </summary> | |
999 <typeparam name="TMessage">The type of message that the recipient registers | |
1000 for.</typeparam> | |
1001 <param name="recipient">The recipient that will receive the messages.</param> | |
1002 <param name="token">A token for a messaging channel. If a recipient registers | |
1003 using a token, and a sender sends a message using the same token, then this | |
1004 message will be delivered to the recipient. Other recipients who did not | |
1005 use a token when registering (or who used a different token) will not | |
1006 get the message. Similarly, messages sent without any token, or with a different | |
1007 token, will not be delivered to that recipient.</param> | |
1008 <param name="receiveDerivedMessagesToo">If true, message types deriving from | |
1009 TMessage will also be transmitted to the recipient. For example, if a SendOrderMessage | |
1010 and an ExecuteOrderMessage derive from OrderMessage, registering for OrderMessage | |
1011 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
1012 and ExecuteOrderMessage to the recipient that registered. | |
1013 <para>Also, if TMessage is an interface, message types implementing TMessage will also be | |
1014 transmitted to the recipient. For example, if a SendOrderMessage | |
1015 and an ExecuteOrderMessage implement IOrderMessage, registering for IOrderMessage | |
1016 and setting receiveDerivedMessagesToo to true will send SendOrderMessage | |
1017 and ExecuteOrderMessage to the recipient that registered.</para> | |
1018 </param> | |
1019 <param name="action">The action that will be executed when a message | |
1020 of type TMessage is sent.</param> | |
1021 </member> | |
1022 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Send``1(``0)"> | |
1023 <summary> | |
1024 Sends a message to registered recipients. The message will | |
1025 reach all recipients that registered for this message type | |
1026 using one of the Register methods. | |
1027 </summary> | |
1028 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
1029 <param name="message">The message to send to registered recipients.</param> | |
1030 </member> | |
1031 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Send``2(``0)"> | |
1032 <summary> | |
1033 Sends a message to registered recipients. The message will | |
1034 reach only recipients that registered for this message type | |
1035 using one of the Register methods, and that are | |
1036 of the targetType. | |
1037 </summary> | |
1038 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
1039 <typeparam name="TTarget">The type of recipients that will receive | |
1040 the message. The message won't be sent to recipients of another type.</typeparam> | |
1041 <param name="message">The message to send to registered recipients.</param> | |
1042 </member> | |
1043 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Send``1(``0,System.Object)"> | |
1044 <summary> | |
1045 Sends a message to registered recipients. The message will | |
1046 reach only recipients that registered for this message type | |
1047 using one of the Register methods, and that are | |
1048 of the targetType. | |
1049 </summary> | |
1050 <typeparam name="TMessage">The type of message that will be sent.</typeparam> | |
1051 <param name="message">The message to send to registered recipients.</param> | |
1052 <param name="token">A token for a messaging channel. If a recipient registers | |
1053 using a token, and a sender sends a message using the same token, then this | |
1054 message will be delivered to the recipient. Other recipients who did not | |
1055 use a token when registering (or who used a different token) will not | |
1056 get the message. Similarly, messages sent without any token, or with a different | |
1057 token, will not be delivered to that recipient.</param> | |
1058 </member> | |
1059 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Unregister(System.Object)"> | |
1060 <summary> | |
1061 Unregisters a messager recipient completely. After this method | |
1062 is executed, the recipient will not receive any messages anymore. | |
1063 </summary> | |
1064 <param name="recipient">The recipient that must be unregistered.</param> | |
1065 </member> | |
1066 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Unregister``1(System.Object)"> | |
1067 <summary> | |
1068 Unregisters a message recipient for a given type of messages only. | |
1069 After this method is executed, the recipient will not receive messages | |
1070 of type TMessage anymore, but will still receive other message types (if it | |
1071 registered for them previously). | |
1072 </summary> | |
1073 <param name="recipient">The recipient that must be unregistered.</param> | |
1074 <typeparam name="TMessage">The type of messages that the recipient wants | |
1075 to unregister from.</typeparam> | |
1076 </member> | |
1077 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Unregister``1(System.Object,System.Object)"> | |
1078 <summary> | |
1079 Unregisters a message recipient for a given type of messages only and for a given token. | |
1080 After this method is executed, the recipient will not receive messages | |
1081 of type TMessage anymore with the given token, but will still receive other message types | |
1082 or messages with other tokens (if it registered for them previously). | |
1083 </summary> | |
1084 <param name="recipient">The recipient that must be unregistered.</param> | |
1085 <param name="token">The token for which the recipient must be unregistered.</param> | |
1086 <typeparam name="TMessage">The type of messages that the recipient wants | |
1087 to unregister from.</typeparam> | |
1088 </member> | |
1089 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Unregister``1(System.Object,System.Action{``0})"> | |
1090 <summary> | |
1091 Unregisters a message recipient for a given type of messages and for | |
1092 a given action. Other message types will still be transmitted to the | |
1093 recipient (if it registered for them previously). Other actions that have | |
1094 been registered for the message type TMessage and for the given recipient (if | |
1095 available) will also remain available. | |
1096 </summary> | |
1097 <typeparam name="TMessage">The type of messages that the recipient wants | |
1098 to unregister from.</typeparam> | |
1099 <param name="recipient">The recipient that must be unregistered.</param> | |
1100 <param name="action">The action that must be unregistered for | |
1101 the recipient and for the message type TMessage.</param> | |
1102 </member> | |
1103 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Unregister``1(System.Object,System.Object,System.Action{``0})"> | |
1104 <summary> | |
1105 Unregisters a message recipient for a given type of messages, for | |
1106 a given action and a given token. Other message types will still be transmitted to the | |
1107 recipient (if it registered for them previously). Other actions that have | |
1108 been registered for the message type TMessage, for the given recipient and other tokens (if | |
1109 available) will also remain available. | |
1110 </summary> | |
1111 <typeparam name="TMessage">The type of messages that the recipient wants | |
1112 to unregister from.</typeparam> | |
1113 <param name="recipient">The recipient that must be unregistered.</param> | |
1114 <param name="token">The token for which the recipient must be unregistered.</param> | |
1115 <param name="action">The action that must be unregistered for | |
1116 the recipient and for the message type TMessage.</param> | |
1117 </member> | |
1118 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.OverrideDefault(GalaSoft.MvvmLight.Messaging.IMessenger)"> | |
1119 <summary> | |
1120 Provides a way to override the Messenger.Default instance with | |
1121 a custom instance, for example for unit testing purposes. | |
1122 </summary> | |
1123 <param name="newMessenger">The instance that will be used as Messenger.Default.</param> | |
1124 </member> | |
1125 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Reset"> | |
1126 <summary> | |
1127 Sets the Messenger's default (static) instance to null. | |
1128 </summary> | |
1129 </member> | |
1130 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.ResetAll"> | |
1131 <summary> | |
1132 Provides a non-static access to the static <see cref="M:GalaSoft.MvvmLight.Messaging.Messenger.Reset"/> method. | |
1133 Sets the Messenger's default (static) instance to null. | |
1134 </summary> | |
1135 </member> | |
1136 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.RequestCleanup"> | |
1137 <summary> | |
1138 Notifies the Messenger that the lists of recipients should | |
1139 be scanned and cleaned up. | |
1140 Since recipients are stored as <see cref="T:System.WeakReference"/>, | |
1141 recipients can be garbage collected even though the Messenger keeps | |
1142 them in a list. During the cleanup operation, all "dead" | |
1143 recipients are removed from the lists. Since this operation | |
1144 can take a moment, it is only executed when the application is | |
1145 idle. For this reason, a user of the Messenger class should use | |
1146 <see cref="M:GalaSoft.MvvmLight.Messaging.Messenger.RequestCleanup"/> instead of forcing one with the | |
1147 <see cref="M:GalaSoft.MvvmLight.Messaging.Messenger.Cleanup"/> method. | |
1148 </summary> | |
1149 </member> | |
1150 <member name="M:GalaSoft.MvvmLight.Messaging.Messenger.Cleanup"> | |
1151 <summary> | |
1152 Scans the recipients' lists for "dead" instances and removes them. | |
1153 Since recipients are stored as <see cref="T:System.WeakReference"/>, | |
1154 recipients can be garbage collected even though the Messenger keeps | |
1155 them in a list. During the cleanup operation, all "dead" | |
1156 recipients are removed from the lists. Since this operation | |
1157 can take a moment, it is only executed when the application is | |
1158 idle. For this reason, a user of the Messenger class should use | |
1159 <see cref="M:GalaSoft.MvvmLight.Messaging.Messenger.RequestCleanup"/> instead of forcing one with the | |
1160 <see cref="M:GalaSoft.MvvmLight.Messaging.Messenger.Cleanup"/> method. | |
1161 </summary> | |
1162 </member> | |
1163 <member name="P:GalaSoft.MvvmLight.Messaging.Messenger.Default"> | |
1164 <summary> | |
1165 Gets the Messenger's default instance, allowing | |
1166 to register and send messages in a static manner. | |
1167 </summary> | |
1168 </member> | |
1169 <member name="T:GalaSoft.MvvmLight.ObservableObject"> | |
1170 <summary> | |
1171 A base class for objects of which the properties must be observable. | |
1172 </summary> | |
1173 </member> | |
1174 <member name="M:GalaSoft.MvvmLight.ObservableObject.VerifyPropertyName(System.String)"> | |
1175 <summary> | |
1176 Verifies that a property name exists in this ViewModel. This method | |
1177 can be called before the property is used, for instance before | |
1178 calling RaisePropertyChanged. It avoids errors when a property name | |
1179 is changed but some places are missed. | |
1180 <para>This method is only active in DEBUG mode.</para> | |
1181 </summary> | |
1182 <param name="propertyName"></param> | |
1183 </member> | |
1184 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanging(System.String)"> | |
1185 <summary> | |
1186 Raises the PropertyChanging event if needed. | |
1187 </summary> | |
1188 <remarks>If the propertyName parameter | |
1189 does not correspond to an existing property on the current class, an | |
1190 exception is thrown in DEBUG configuration only.</remarks> | |
1191 <param name="propertyName">The name of the property that | |
1192 changed.</param> | |
1193 </member> | |
1194 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanged(System.String)"> | |
1195 <summary> | |
1196 Raises the PropertyChanged event if needed. | |
1197 </summary> | |
1198 <remarks>If the propertyName parameter | |
1199 does not correspond to an existing property on the current class, an | |
1200 exception is thrown in DEBUG configuration only.</remarks> | |
1201 <param name="propertyName">The name of the property that | |
1202 changed.</param> | |
1203 </member> | |
1204 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanging``1(System.Linq.Expressions.Expression{System.Func{``0}})"> | |
1205 <summary> | |
1206 Raises the PropertyChanging event if needed. | |
1207 </summary> | |
1208 <typeparam name="T">The type of the property that | |
1209 changes.</typeparam> | |
1210 <param name="propertyExpression">An expression identifying the property | |
1211 that changes.</param> | |
1212 </member> | |
1213 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanged``1(System.Linq.Expressions.Expression{System.Func{``0}})"> | |
1214 <summary> | |
1215 Raises the PropertyChanged event if needed. | |
1216 </summary> | |
1217 <typeparam name="T">The type of the property that | |
1218 changed.</typeparam> | |
1219 <param name="propertyExpression">An expression identifying the property | |
1220 that changed.</param> | |
1221 </member> | |
1222 <member name="M:GalaSoft.MvvmLight.ObservableObject.GetPropertyName``1(System.Linq.Expressions.Expression{System.Func{``0}})"> | |
1223 <summary> | |
1224 Extracts the name of a property from an expression. | |
1225 </summary> | |
1226 <typeparam name="T">The type of the property.</typeparam> | |
1227 <param name="propertyExpression">An expression returning the property's name.</param> | |
1228 <returns>The name of the property returned by the expression.</returns> | |
1229 <exception cref="T:System.ArgumentNullException">If the expression is null.</exception> | |
1230 <exception cref="T:System.ArgumentException">If the expression does not represent a property.</exception> | |
1231 </member> | |
1232 <member name="M:GalaSoft.MvvmLight.ObservableObject.Set``1(System.Linq.Expressions.Expression{System.Func{``0}},``0@,``0)"> | |
1233 <summary> | |
1234 Assigns a new value to the property. Then, raises the | |
1235 PropertyChanged event if needed. | |
1236 </summary> | |
1237 <typeparam name="T">The type of the property that | |
1238 changed.</typeparam> | |
1239 <param name="propertyExpression">An expression identifying the property | |
1240 that changed.</param> | |
1241 <param name="field">The field storing the property's value.</param> | |
1242 <param name="newValue">The property's value after the change | |
1243 occurred.</param> | |
1244 <returns>True if the PropertyChanged event has been raised, | |
1245 false otherwise. The event is not raised if the old | |
1246 value is equal to the new value.</returns> | |
1247 </member> | |
1248 <member name="M:GalaSoft.MvvmLight.ObservableObject.Set``1(System.String,``0@,``0)"> | |
1249 <summary> | |
1250 Assigns a new value to the property. Then, raises the | |
1251 PropertyChanged event if needed. | |
1252 </summary> | |
1253 <typeparam name="T">The type of the property that | |
1254 changed.</typeparam> | |
1255 <param name="propertyName">The name of the property that | |
1256 changed.</param> | |
1257 <param name="field">The field storing the property's value.</param> | |
1258 <param name="newValue">The property's value after the change | |
1259 occurred.</param> | |
1260 <returns>True if the PropertyChanged event has been raised, | |
1261 false otherwise. The event is not raised if the old | |
1262 value is equal to the new value.</returns> | |
1263 </member> | |
1264 <member name="E:GalaSoft.MvvmLight.ObservableObject.PropertyChanged"> | |
1265 <summary> | |
1266 Occurs after a property value changes. | |
1267 </summary> | |
1268 </member> | |
1269 <member name="E:GalaSoft.MvvmLight.ObservableObject.PropertyChanging"> | |
1270 <summary> | |
1271 Occurs before a property value changes. | |
1272 </summary> | |
1273 </member> | |
1274 <member name="P:GalaSoft.MvvmLight.ObservableObject.PropertyChangedHandler"> | |
1275 <summary> | |
1276 Provides access to the PropertyChanged event handler to derived classes. | |
1277 </summary> | |
1278 </member> | |
1279 <member name="P:GalaSoft.MvvmLight.ObservableObject.PropertyChangingHandler"> | |
1280 <summary> | |
1281 Provides access to the PropertyChanging event handler to derived classes. | |
1282 </summary> | |
1283 </member> | |
1284 <member name="T:GalaSoft.MvvmLight.Command.RelayCommand`1"> | |
1285 <summary> | |
1286 A generic command whose sole purpose is to relay its functionality to other | |
1287 objects by invoking delegates. The default return value for the CanExecute | |
1288 method is 'true'. This class allows you to accept command parameters in the | |
1289 Execute and CanExecute callback methods. | |
1290 </summary> | |
1291 <typeparam name="T">The type of the command parameter.</typeparam> | |
1292 </member> | |
1293 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.#ctor(System.Action{`0})"> | |
1294 <summary> | |
1295 Initializes a new instance of the RelayCommand class that | |
1296 can always execute. | |
1297 </summary> | |
1298 <param name="execute">The execution logic.</param> | |
1299 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1300 </member> | |
1301 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.#ctor(System.Action{`0},System.Func{`0,System.Boolean})"> | |
1302 <summary> | |
1303 Initializes a new instance of the RelayCommand class. | |
1304 </summary> | |
1305 <param name="execute">The execution logic.</param> | |
1306 <param name="canExecute">The execution status logic.</param> | |
1307 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1308 </member> | |
1309 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.RaiseCanExecuteChanged"> | |
1310 <summary> | |
1311 Raises the <see cref="E:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecuteChanged"/> event. | |
1312 </summary> | |
1313 </member> | |
1314 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecute(System.Object)"> | |
1315 <summary> | |
1316 Defines the method that determines whether the command can execute in its current state. | |
1317 </summary> | |
1318 <param name="parameter">Data used by the command. If the command does not require data | |
1319 to be passed, this object can be set to a null reference</param> | |
1320 <returns>true if this command can be executed; otherwise, false.</returns> | |
1321 </member> | |
1322 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.Execute(System.Object)"> | |
1323 <summary> | |
1324 Defines the method to be called when the command is invoked. | |
1325 </summary> | |
1326 <param name="parameter">Data used by the command. If the command does not require data | |
1327 to be passed, this object can be set to a null reference</param> | |
1328 </member> | |
1329 <member name="E:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecuteChanged"> | |
1330 <summary> | |
1331 Occurs when changes occur that affect whether the command should execute. | |
1332 </summary> | |
1333 </member> | |
1334 <member name="T:GalaSoft.MvvmLight.Command.RelayCommand"> | |
1335 <summary> | |
1336 A command whose sole purpose is to relay its functionality to other | |
1337 objects by invoking delegates. The default return value for the CanExecute | |
1338 method is 'true'. This class does not allow you to accept command parameters in the | |
1339 Execute and CanExecute callback methods. | |
1340 </summary> | |
1341 </member> | |
1342 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand.#ctor(System.Action)"> | |
1343 <summary> | |
1344 Initializes a new instance of the RelayCommand class that | |
1345 can always execute. | |
1346 </summary> | |
1347 <param name="execute">The execution logic.</param> | |
1348 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1349 </member> | |
1350 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand.#ctor(System.Action,System.Func{System.Boolean})"> | |
1351 <summary> | |
1352 Initializes a new instance of the RelayCommand class. | |
1353 </summary> | |
1354 <param name="execute">The execution logic.</param> | |
1355 <param name="canExecute">The execution status logic.</param> | |
1356 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1357 </member> | |
1358 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand.RaiseCanExecuteChanged"> | |
1359 <summary> | |
1360 Raises the <see cref="E:GalaSoft.MvvmLight.Command.RelayCommand.CanExecuteChanged"/> event. | |
1361 </summary> | |
1362 </member> | |
1363 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand.CanExecute(System.Object)"> | |
1364 <summary> | |
1365 Defines the method that determines whether the command can execute in its current state. | |
1366 </summary> | |
1367 <param name="parameter">This parameter will always be ignored.</param> | |
1368 <returns>true if this command can be executed; otherwise, false.</returns> | |
1369 </member> | |
1370 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand.Execute(System.Object)"> | |
1371 <summary> | |
1372 Defines the method to be called when the command is invoked. | |
1373 </summary> | |
1374 <param name="parameter">This parameter will always be ignored.</param> | |
1375 </member> | |
1376 <member name="E:GalaSoft.MvvmLight.Command.RelayCommand.CanExecuteChanged"> | |
1377 <summary> | |
1378 Occurs when changes occur that affect whether the command should execute. | |
1379 </summary> | |
1380 </member> | |
1381 <member name="T:GalaSoft.MvvmLight.ViewModelBase"> | |
1382 <summary> | |
1383 A base class for the ViewModel classes in the MVVM pattern. | |
1384 </summary> | |
1385 </member> | |
1386 <member name="M:GalaSoft.MvvmLight.ViewModelBase.#ctor"> | |
1387 <summary> | |
1388 Initializes a new instance of the ViewModelBase class. | |
1389 </summary> | |
1390 </member> | |
1391 <member name="M:GalaSoft.MvvmLight.ViewModelBase.#ctor(GalaSoft.MvvmLight.Messaging.IMessenger)"> | |
1392 <summary> | |
1393 Initializes a new instance of the ViewModelBase class. | |
1394 </summary> | |
1395 <param name="messenger">An instance of a <see cref="T:GalaSoft.MvvmLight.Messaging.Messenger"/> | |
1396 used to broadcast messages to other objects. If null, this class | |
1397 will attempt to broadcast using the Messenger's default | |
1398 instance.</param> | |
1399 </member> | |
1400 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Cleanup"> | |
1401 <summary> | |
1402 Unregisters this instance from the Messenger class. | |
1403 <para>To cleanup additional resources, override this method, clean | |
1404 up and then call base.Cleanup().</para> | |
1405 </summary> | |
1406 </member> | |
1407 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Broadcast``1(``0,``0,System.String)"> | |
1408 <summary> | |
1409 Broadcasts a PropertyChangedMessage using either the instance of | |
1410 the Messenger that was passed to this class (if available) | |
1411 or the Messenger's default instance. | |
1412 </summary> | |
1413 <typeparam name="T">The type of the property that | |
1414 changed.</typeparam> | |
1415 <param name="oldValue">The value of the property before it | |
1416 changed.</param> | |
1417 <param name="newValue">The value of the property after it | |
1418 changed.</param> | |
1419 <param name="propertyName">The name of the property that | |
1420 changed.</param> | |
1421 </member> | |
1422 <member name="M:GalaSoft.MvvmLight.ViewModelBase.RaisePropertyChanged``1(System.String,``0,``0,System.Boolean)"> | |
1423 <summary> | |
1424 Raises the PropertyChanged event if needed, and broadcasts a | |
1425 PropertyChangedMessage using the Messenger instance (or the | |
1426 static default instance if no Messenger instance is available). | |
1427 </summary> | |
1428 <typeparam name="T">The type of the property that | |
1429 changed.</typeparam> | |
1430 <param name="propertyName">The name of the property that | |
1431 changed.</param> | |
1432 <param name="oldValue">The property's value before the change | |
1433 occurred.</param> | |
1434 <param name="newValue">The property's value after the change | |
1435 occurred.</param> | |
1436 <param name="broadcast">If true, a PropertyChangedMessage will | |
1437 be broadcasted. If false, only the event will be raised.</param> | |
1438 <remarks>If the propertyName parameter | |
1439 does not correspond to an existing property on the current class, an | |
1440 exception is thrown in DEBUG configuration only.</remarks> | |
1441 </member> | |
1442 <member name="M:GalaSoft.MvvmLight.ViewModelBase.RaisePropertyChanged``1(System.Linq.Expressions.Expression{System.Func{``0}},``0,``0,System.Boolean)"> | |
1443 <summary> | |
1444 Raises the PropertyChanged event if needed, and broadcasts a | |
1445 PropertyChangedMessage using the Messenger instance (or the | |
1446 static default instance if no Messenger instance is available). | |
1447 </summary> | |
1448 <typeparam name="T">The type of the property that | |
1449 changed.</typeparam> | |
1450 <param name="propertyExpression">An expression identifying the property | |
1451 that changed.</param> | |
1452 <param name="oldValue">The property's value before the change | |
1453 occurred.</param> | |
1454 <param name="newValue">The property's value after the change | |
1455 occurred.</param> | |
1456 <param name="broadcast">If true, a PropertyChangedMessage will | |
1457 be broadcasted. If false, only the event will be raised.</param> | |
1458 </member> | |
1459 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Set``1(System.Linq.Expressions.Expression{System.Func{``0}},``0@,``0,System.Boolean)"> | |
1460 <summary> | |
1461 Assigns a new value to the property. Then, raises the | |
1462 PropertyChanged event if needed, and broadcasts a | |
1463 PropertyChangedMessage using the Messenger instance (or the | |
1464 static default instance if no Messenger instance is available). | |
1465 </summary> | |
1466 <typeparam name="T">The type of the property that | |
1467 changed.</typeparam> | |
1468 <param name="propertyExpression">An expression identifying the property | |
1469 that changed.</param> | |
1470 <param name="field">The field storing the property's value.</param> | |
1471 <param name="newValue">The property's value after the change | |
1472 occurred.</param> | |
1473 <param name="broadcast">If true, a PropertyChangedMessage will | |
1474 be broadcasted. If false, only the event will be raised.</param> | |
1475 </member> | |
1476 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Set``1(System.String,``0@,``0,System.Boolean)"> | |
1477 <summary> | |
1478 Assigns a new value to the property. Then, raises the | |
1479 PropertyChanged event if needed, and broadcasts a | |
1480 PropertyChangedMessage using the Messenger instance (or the | |
1481 static default instance if no Messenger instance is available). | |
1482 </summary> | |
1483 <typeparam name="T">The type of the property that | |
1484 changed.</typeparam> | |
1485 <param name="propertyName">The name of the property that | |
1486 changed.</param> | |
1487 <param name="field">The field storing the property's value.</param> | |
1488 <param name="newValue">The property's value after the change | |
1489 occurred.</param> | |
1490 <param name="broadcast">If true, a PropertyChangedMessage will | |
1491 be broadcasted. If false, only the event will be raised.</param> | |
1492 </member> | |
1493 <member name="P:GalaSoft.MvvmLight.ViewModelBase.IsInDesignMode"> | |
1494 <summary> | |
1495 Gets a value indicating whether the control is in design mode | |
1496 (running under Blend or Visual Studio). | |
1497 </summary> | |
1498 </member> | |
1499 <member name="P:GalaSoft.MvvmLight.ViewModelBase.IsInDesignModeStatic"> | |
1500 <summary> | |
1501 Gets a value indicating whether the control is in design mode | |
1502 (running in Blend or Visual Studio). | |
1503 </summary> | |
1504 </member> | |
1505 <member name="P:GalaSoft.MvvmLight.ViewModelBase.MessengerInstance"> | |
1506 <summary> | |
1507 Gets or sets an instance of a <see cref="T:GalaSoft.MvvmLight.Messaging.IMessenger"/> used to | |
1508 broadcast messages to other objects. If null, this class will | |
1509 attempt to broadcast using the Messenger's default instance. | |
1510 </summary> | |
1511 </member> | |
1512 <member name="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"> | |
1513 <summary> | |
1514 Passes a string property name (PropertyName) and a generic value | |
1515 (<see cref="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.OldValue"/> and <see cref="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.NewValue"/>) to a recipient. | |
1516 This message type can be used to propagate a PropertyChanged event to | |
1517 a recipient using the messenging system. | |
1518 </summary> | |
1519 <typeparam name="T">The type of the OldValue and NewValue property.</typeparam> | |
1520 </member> | |
1521 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(System.Object,`0,`0,System.String)"> | |
1522 <summary> | |
1523 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1524 </summary> | |
1525 <param name="sender">The message's sender.</param> | |
1526 <param name="oldValue">The property's value before the change occurred.</param> | |
1527 <param name="newValue">The property's value after the change occurred.</param> | |
1528 <param name="propertyName">The name of the property that changed.</param> | |
1529 </member> | |
1530 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(`0,`0,System.String)"> | |
1531 <summary> | |
1532 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1533 </summary> | |
1534 <param name="oldValue">The property's value before the change occurred.</param> | |
1535 <param name="newValue">The property's value after the change occurred.</param> | |
1536 <param name="propertyName">The name of the property that changed.</param> | |
1537 </member> | |
1538 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(System.Object,System.Object,`0,`0,System.String)"> | |
1539 <summary> | |
1540 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1541 </summary> | |
1542 <param name="sender">The message's sender.</param> | |
1543 <param name="target">The message's intended target. This parameter can be used | |
1544 to give an indication as to whom the message was intended for. Of course | |
1545 this is only an indication, amd may be null.</param> | |
1546 <param name="oldValue">The property's value before the change occurred.</param> | |
1547 <param name="newValue">The property's value after the change occurred.</param> | |
1548 <param name="propertyName">The name of the property that changed.</param> | |
1549 </member> | |
1550 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.NewValue"> | |
1551 <summary> | |
1552 Gets the value that the property has after the change. | |
1553 </summary> | |
1554 </member> | |
1555 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.OldValue"> | |
1556 <summary> | |
1557 Gets the value that the property had before the change. | |
1558 </summary> | |
1559 </member> | |
1560 <member name="T:GalaSoft.MvvmLight.Messaging.DialogMessage"> | |
1561 <summary> | |
1562 Use this class to send a message requesting to display a message box with features | |
1563 corresponding to this message's properties. The Callback property should be used | |
1564 to notify the message's sender about the user's choice in the message box. | |
1565 Typically, you can use this message typ's recipient will be an element of the View, | |
1566 and the sender will possibly be a ViewModel. | |
1567 </summary> | |
1568 </member> | |
1569 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1570 <summary> | |
1571 Initializes a new instance of the DialogMessage class. | |
1572 </summary> | |
1573 <param name="content">The text displayed by the message box.</param> | |
1574 <param name="callback">A callback method that should be executed to deliver the result | |
1575 of the message box to the object that sent the message.</param> | |
1576 </member> | |
1577 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.Object,System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1578 <summary> | |
1579 Initializes a new instance of the DialogMessage class. | |
1580 </summary> | |
1581 <param name="sender">The message's original sender.</param> | |
1582 <param name="content">The text displayed by the message box.</param> | |
1583 <param name="callback">A callback method that should be executed to deliver the result | |
1584 of the message box to the object that sent the message.</param> | |
1585 </member> | |
1586 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.Object,System.Object,System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1587 <summary> | |
1588 Initializes a new instance of the DialogMessage class. | |
1589 </summary> | |
1590 <param name="sender">The message's original sender.</param> | |
1591 <param name="target">The message's intended target. This parameter can be used | |
1592 to give an indication as to whom the message was intended for. Of course | |
1593 this is only an indication, amd may be null.</param> | |
1594 <param name="content">The text displayed by the message box.</param> | |
1595 <param name="callback">A callback method that should be executed to deliver the result | |
1596 of the message box to the object that sent the message.</param> | |
1597 </member> | |
1598 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.ProcessCallback(System.Windows.MessageBoxResult)"> | |
1599 <summary> | |
1600 Utility method, checks if the <see cref="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Callback"/> property is | |
1601 null, and if it is not null, executes it. | |
1602 </summary> | |
1603 <param name="result">The result that must be passed | |
1604 to the dialog message caller.</param> | |
1605 </member> | |
1606 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Button"> | |
1607 <summary> | |
1608 Gets or sets the buttons displayed by the message box. | |
1609 </summary> | |
1610 </member> | |
1611 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Callback"> | |
1612 <summary> | |
1613 Gets a callback method that should be executed to deliver the result | |
1614 of the message box to the object that sent the message. | |
1615 </summary> | |
1616 </member> | |
1617 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Caption"> | |
1618 <summary> | |
1619 Gets or sets the caption for the message box. | |
1620 </summary> | |
1621 </member> | |
1622 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.DefaultResult"> | |
1623 <summary> | |
1624 Gets or sets which result is the default in the message box. | |
1625 </summary> | |
1626 </member> | |
1627 </members> | |
1628 </doc> |