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