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