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