Mercurial > silverbladetech
comparison Messaging/Libs/MvvmLight.4.0/GalaSoft.MvvmLight.WPF4.xml @ 26:045dac571339
Working on data binding to a user control
author | adminsh@apollo |
---|---|
date | Wed, 21 Mar 2012 15:39:53 +0000 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
25:81f9b72a44ce | 26:045dac571339 |
---|---|
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.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.Threading.DispatcherHelper"> | |
477 <summary> | |
478 Helper class for dispatcher operations on the UI thread. | |
479 </summary> | |
480 </member> | |
481 <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)"> | |
482 <summary> | |
483 Executes an action on the UI thread. If this method is called | |
484 from the UI thread, the action is executed immendiately. If the | |
485 method is called from another thread, the action will be enqueued | |
486 on the UI thread's dispatcher and executed asynchronously. | |
487 <para>For additional operations on the UI thread, you can get a | |
488 reference to the UI thread's dispatcher thanks to the property | |
489 <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/></para>. | |
490 </summary> | |
491 <param name="action">The action that will be executed on the UI | |
492 thread.</param> | |
493 </member> | |
494 <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"> | |
495 <summary> | |
496 This method should be called once on the UI thread to ensure that | |
497 the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/> property is initialized. | |
498 <para>In a Silverlight application, call this method in the | |
499 Application_Startup event handler, after the MainPage is constructed.</para> | |
500 <para>In WPF, call this method on the static App() constructor.</para> | |
501 </summary> | |
502 </member> | |
503 <member name="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"> | |
504 <summary> | |
505 Gets a reference to the UI thread's dispatcher, after the | |
506 <see cref="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"/> method has been called on the UI thread. | |
507 </summary> | |
508 </member> | |
509 <member name="T:GalaSoft.MvvmLight.ICleanup"> | |
510 <summary> | |
511 Defines a common interface for classes that should be cleaned up, | |
512 but without the implications that IDisposable presupposes. An instance | |
513 implementing ICleanup can be cleaned up without being | |
514 disposed and garbage collected. | |
515 </summary> | |
516 </member> | |
517 <member name="M:GalaSoft.MvvmLight.ICleanup.Cleanup"> | |
518 <summary> | |
519 Cleans up the instance, for example by saving its state, | |
520 removing resources, etc... | |
521 </summary> | |
522 </member> | |
523 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessage"> | |
524 <summary> | |
525 Passes a string message (Notification) to a recipient. | |
526 <para>Typically, notifications are defined as unique strings in a static class. To define | |
527 a unique string, you can use Guid.NewGuid().ToString() or any other unique | |
528 identifier.</para> | |
529 </summary> | |
530 </member> | |
531 <member name="T:GalaSoft.MvvmLight.Messaging.MessageBase"> | |
532 <summary> | |
533 Base class for all messages broadcasted by the Messenger. | |
534 You can create your own message types by extending this class. | |
535 </summary> | |
536 </member> | |
537 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor"> | |
538 <summary> | |
539 Initializes a new instance of the MessageBase class. | |
540 </summary> | |
541 </member> | |
542 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor(System.Object)"> | |
543 <summary> | |
544 Initializes a new instance of the MessageBase class. | |
545 </summary> | |
546 <param name="sender">The message's original sender.</param> | |
547 </member> | |
548 <member name="M:GalaSoft.MvvmLight.Messaging.MessageBase.#ctor(System.Object,System.Object)"> | |
549 <summary> | |
550 Initializes a new instance of the MessageBase class. | |
551 </summary> | |
552 <param name="sender">The message's original sender.</param> | |
553 <param name="target">The message's intended target. This parameter can be used | |
554 to give an indication as to whom the message was intended for. Of course | |
555 this is only an indication, amd may be null.</param> | |
556 </member> | |
557 <member name="P:GalaSoft.MvvmLight.Messaging.MessageBase.Sender"> | |
558 <summary> | |
559 Gets or sets the message's sender. | |
560 </summary> | |
561 </member> | |
562 <member name="P:GalaSoft.MvvmLight.Messaging.MessageBase.Target"> | |
563 <summary> | |
564 Gets or sets the message's intended target. This property can be used | |
565 to give an indication as to whom the message was intended for. Of course | |
566 this is only an indication, amd may be null. | |
567 </summary> | |
568 </member> | |
569 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.String)"> | |
570 <summary> | |
571 Initializes a new instance of the NotificationMessage class. | |
572 </summary> | |
573 <param name="notification">A string containing any arbitrary message to be | |
574 passed to recipient(s)</param> | |
575 </member> | |
576 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.Object,System.String)"> | |
577 <summary> | |
578 Initializes a new instance of the NotificationMessage class. | |
579 </summary> | |
580 <param name="sender">The message's sender.</param> | |
581 <param name="notification">A string containing any arbitrary message to be | |
582 passed to recipient(s)</param> | |
583 </member> | |
584 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage.#ctor(System.Object,System.Object,System.String)"> | |
585 <summary> | |
586 Initializes a new instance of the NotificationMessage class. | |
587 </summary> | |
588 <param name="sender">The message's sender.</param> | |
589 <param name="target">The message's intended target. This parameter can be used | |
590 to give an indication as to whom the message was intended for. Of course | |
591 this is only an indication, amd may be null.</param> | |
592 <param name="notification">A string containing any arbitrary message to be | |
593 passed to recipient(s)</param> | |
594 </member> | |
595 <member name="P:GalaSoft.MvvmLight.Messaging.NotificationMessage.Notification"> | |
596 <summary> | |
597 Gets a string containing any arbitrary message to be | |
598 passed to recipient(s). | |
599 </summary> | |
600 </member> | |
601 <member name="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"> | |
602 <summary> | |
603 Basis class for the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. This | |
604 class allows a recipient to register for all PropertyChangedMessages without | |
605 having to specify the type T. | |
606 </summary> | |
607 </member> | |
608 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.Object,System.String)"> | |
609 <summary> | |
610 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
611 </summary> | |
612 <param name="sender">The message's sender.</param> | |
613 <param name="propertyName">The name of the property that changed.</param> | |
614 </member> | |
615 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.Object,System.Object,System.String)"> | |
616 <summary> | |
617 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
618 </summary> | |
619 <param name="sender">The message's sender.</param> | |
620 <param name="target">The message's intended target. This parameter can be used | |
621 to give an indication as to whom the message was intended for. Of course | |
622 this is only an indication, amd may be null.</param> | |
623 <param name="propertyName">The name of the property that changed.</param> | |
624 </member> | |
625 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.#ctor(System.String)"> | |
626 <summary> | |
627 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase"/> class. | |
628 </summary> | |
629 <param name="propertyName">The name of the property that changed.</param> | |
630 </member> | |
631 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessageBase.PropertyName"> | |
632 <summary> | |
633 Gets or sets the name of the property that changed. | |
634 </summary> | |
635 </member> | |
636 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"> | |
637 <summary> | |
638 Provides a message class with a built-in callback. When the recipient | |
639 is done processing the message, it can execute the callback to | |
640 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.Execute(System.Object[])"/> | |
641 method to execute the callback. The callback method has one parameter. | |
642 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> and | |
643 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/>. | |
644 </summary> | |
645 </member> | |
646 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.String,System.Delegate)"> | |
647 <summary> | |
648 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
649 </summary> | |
650 <param name="notification">An arbitrary string that will be | |
651 carried by the message.</param> | |
652 <param name="callback">The callback method that can be executed | |
653 by the recipient to notify the sender that the message has been | |
654 processed.</param> | |
655 </member> | |
656 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.Object,System.String,System.Delegate)"> | |
657 <summary> | |
658 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
659 </summary> | |
660 <param name="sender">The message's sender.</param> | |
661 <param name="notification">An arbitrary string that will be | |
662 carried by the message.</param> | |
663 <param name="callback">The callback method that can be executed | |
664 by the recipient to notify the sender that the message has been | |
665 processed.</param> | |
666 </member> | |
667 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.#ctor(System.Object,System.Object,System.String,System.Delegate)"> | |
668 <summary> | |
669 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback"/> class. | |
670 </summary> | |
671 <param name="sender">The message's sender.</param> | |
672 <param name="target">The message's intended target. This parameter can be used | |
673 to give an indication as to whom the message was intended for. Of course | |
674 this is only an indication, amd may be null.</param> | |
675 <param name="notification">An arbitrary string that will be | |
676 carried by the message.</param> | |
677 <param name="callback">The callback method that can be executed | |
678 by the recipient to notify the sender that the message has been | |
679 processed.</param> | |
680 </member> | |
681 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageWithCallback.Execute(System.Object[])"> | |
682 <summary> | |
683 Executes the callback that was provided with the message with an | |
684 arbitrary number of parameters. | |
685 </summary> | |
686 <param name="arguments">A number of parameters that will | |
687 be passed to the callback method.</param> | |
688 <returns>The object returned by the callback method.</returns> | |
689 </member> | |
690 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"> | |
691 <summary> | |
692 Provides a message class with a built-in callback. When the recipient | |
693 is done processing the message, it can execute the callback to | |
694 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.Execute"/> | |
695 method to execute the callback. | |
696 </summary> | |
697 </member> | |
698 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.String,System.Action)"> | |
699 <summary> | |
700 Initializes a new instance of the | |
701 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
702 </summary> | |
703 <param name="notification">An arbitrary string that will be | |
704 carried by the message.</param> | |
705 <param name="callback">The callback method that can be executed | |
706 by the recipient to notify the sender that the message has been | |
707 processed.</param> | |
708 </member> | |
709 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.Object,System.String,System.Action)"> | |
710 <summary> | |
711 Initializes a new instance of the | |
712 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
713 </summary> | |
714 <param name="sender">The message's sender.</param> | |
715 <param name="notification">An arbitrary string that will be | |
716 carried by the message.</param> | |
717 <param name="callback">The callback method that can be executed | |
718 by the recipient to notify the sender that the message has been | |
719 processed.</param> | |
720 </member> | |
721 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.#ctor(System.Object,System.Object,System.String,System.Action)"> | |
722 <summary> | |
723 Initializes a new instance of the | |
724 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/> class. | |
725 </summary> | |
726 <param name="sender">The message's sender.</param> | |
727 <param name="target">The message's intended target. This parameter can be used | |
728 to give an indication as to whom the message was intended for. Of course | |
729 this is only an indication, amd may be null.</param> | |
730 <param name="notification">An arbitrary string that will be | |
731 carried by the message.</param> | |
732 <param name="callback">The callback method that can be executed | |
733 by the recipient to notify the sender that the message has been | |
734 processed.</param> | |
735 </member> | |
736 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction.Execute"> | |
737 <summary> | |
738 Executes the callback that was provided with the message. | |
739 </summary> | |
740 </member> | |
741 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessage`1"> | |
742 <summary> | |
743 Passes a string message (Notification) and a generic value (Content) to a recipient. | |
744 </summary> | |
745 <typeparam name="T">The type of the Content property.</typeparam> | |
746 </member> | |
747 <member name="T:GalaSoft.MvvmLight.Messaging.GenericMessage`1"> | |
748 <summary> | |
749 Passes a generic value (Content) to a recipient. | |
750 </summary> | |
751 <typeparam name="T">The type of the Content property.</typeparam> | |
752 </member> | |
753 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(`0)"> | |
754 <summary> | |
755 Initializes a new instance of the GenericMessage class. | |
756 </summary> | |
757 <param name="content">The message content.</param> | |
758 </member> | |
759 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(System.Object,`0)"> | |
760 <summary> | |
761 Initializes a new instance of the GenericMessage class. | |
762 </summary> | |
763 <param name="sender">The message's sender.</param> | |
764 <param name="content">The message content.</param> | |
765 </member> | |
766 <member name="M:GalaSoft.MvvmLight.Messaging.GenericMessage`1.#ctor(System.Object,System.Object,`0)"> | |
767 <summary> | |
768 Initializes a new instance of the GenericMessage class. | |
769 </summary> | |
770 <param name="sender">The message's sender.</param> | |
771 <param name="target">The message's intended target. This parameter can be used | |
772 to give an indication as to whom the message was intended for. Of course | |
773 this is only an indication, amd may be null.</param> | |
774 <param name="content">The message content.</param> | |
775 </member> | |
776 <member name="P:GalaSoft.MvvmLight.Messaging.GenericMessage`1.Content"> | |
777 <summary> | |
778 Gets or sets the message's content. | |
779 </summary> | |
780 </member> | |
781 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(`0,System.String)"> | |
782 <summary> | |
783 Initializes a new instance of the NotificationMessage class. | |
784 </summary> | |
785 <param name="content">A value to be passed to recipient(s).</param> | |
786 <param name="notification">A string containing any arbitrary message to be | |
787 passed to recipient(s)</param> | |
788 </member> | |
789 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(System.Object,`0,System.String)"> | |
790 <summary> | |
791 Initializes a new instance of the NotificationMessage class. | |
792 </summary> | |
793 <param name="sender">The message's sender.</param> | |
794 <param name="content">A value to be passed to recipient(s).</param> | |
795 <param name="notification">A string containing any arbitrary message to be | |
796 passed to recipient(s)</param> | |
797 </member> | |
798 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.#ctor(System.Object,System.Object,`0,System.String)"> | |
799 <summary> | |
800 Initializes a new instance of the NotificationMessage class. | |
801 </summary> | |
802 <param name="sender">The message's sender.</param> | |
803 <param name="target">The message's intended target. This parameter can be used | |
804 to give an indication as to whom the message was intended for. Of course | |
805 this is only an indication, amd may be null.</param> | |
806 <param name="content">A value to be passed to recipient(s).</param> | |
807 <param name="notification">A string containing any arbitrary message to be | |
808 passed to recipient(s)</param> | |
809 </member> | |
810 <member name="P:GalaSoft.MvvmLight.Messaging.NotificationMessage`1.Notification"> | |
811 <summary> | |
812 Gets a string containing any arbitrary message to be | |
813 passed to recipient(s). | |
814 </summary> | |
815 </member> | |
816 <member name="T:GalaSoft.MvvmLight.ViewModelBase"> | |
817 <summary> | |
818 A base class for the ViewModel classes in the MVVM pattern. | |
819 </summary> | |
820 </member> | |
821 <member name="T:GalaSoft.MvvmLight.ObservableObject"> | |
822 <summary> | |
823 A base class for the ViewModel classes in the MVVM pattern. | |
824 </summary> | |
825 </member> | |
826 <member name="M:GalaSoft.MvvmLight.ObservableObject.VerifyPropertyName(System.String)"> | |
827 <summary> | |
828 Verifies that a property name exists in this ViewModel. This method | |
829 can be called before the property is used, for instance before | |
830 calling RaisePropertyChanged. It avoids errors when a property name | |
831 is changed but some places are missed. | |
832 <para>This method is only active in DEBUG mode.</para> | |
833 </summary> | |
834 <param name="propertyName"></param> | |
835 </member> | |
836 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanged(System.String)"> | |
837 <summary> | |
838 Raises the PropertyChanged event if needed. | |
839 </summary> | |
840 <remarks>If the propertyName parameter | |
841 does not correspond to an existing property on the current class, an | |
842 exception is thrown in DEBUG configuration only.</remarks> | |
843 <param name="propertyName">The name of the property that | |
844 changed.</param> | |
845 </member> | |
846 <member name="M:GalaSoft.MvvmLight.ObservableObject.RaisePropertyChanged``1(System.Linq.Expressions.Expression{System.Func{``0}})"> | |
847 <summary> | |
848 Raises the PropertyChanged event if needed. | |
849 </summary> | |
850 <typeparam name="T">The type of the property that | |
851 changed.</typeparam> | |
852 <param name="propertyExpression">An expression identifying the property | |
853 that changed.</param> | |
854 </member> | |
855 <member name="M:GalaSoft.MvvmLight.ObservableObject.Set``1(System.Linq.Expressions.Expression{System.Func{``0}},``0@,``0)"> | |
856 <summary> | |
857 Assigns a new value to the property. Then, raises the | |
858 PropertyChanged event if needed. | |
859 </summary> | |
860 <typeparam name="T">The type of the property that | |
861 changed.</typeparam> | |
862 <param name="propertyExpression">An expression identifying the property | |
863 that changed.</param> | |
864 <param name="field">The field storing the property's value.</param> | |
865 <param name="newValue">The property's value after the change | |
866 occurred.</param> | |
867 </member> | |
868 <member name="M:GalaSoft.MvvmLight.ObservableObject.Set``1(System.String,``0@,``0)"> | |
869 <summary> | |
870 Assigns a new value to the property. Then, raises the | |
871 PropertyChanged event if needed. | |
872 </summary> | |
873 <typeparam name="T">The type of the property that | |
874 changed.</typeparam> | |
875 <param name="propertyName">The name of the property that | |
876 changed.</param> | |
877 <param name="field">The field storing the property's value.</param> | |
878 <param name="newValue">The property's value after the change | |
879 occurred.</param> | |
880 </member> | |
881 <member name="E:GalaSoft.MvvmLight.ObservableObject.PropertyChanged"> | |
882 <summary> | |
883 Occurs when a property value changes. | |
884 </summary> | |
885 </member> | |
886 <member name="P:GalaSoft.MvvmLight.ObservableObject.PropertyChangedHandler"> | |
887 <summary> | |
888 Provides access to the PropertyChanged event handler to derived classes. | |
889 </summary> | |
890 </member> | |
891 <member name="M:GalaSoft.MvvmLight.ViewModelBase.#ctor"> | |
892 <summary> | |
893 Initializes a new instance of the ViewModelBase class. | |
894 </summary> | |
895 </member> | |
896 <member name="M:GalaSoft.MvvmLight.ViewModelBase.#ctor(GalaSoft.MvvmLight.Messaging.IMessenger)"> | |
897 <summary> | |
898 Initializes a new instance of the ViewModelBase class. | |
899 </summary> | |
900 <param name="messenger">An instance of a <see cref="T:GalaSoft.MvvmLight.Messaging.Messenger"/> | |
901 used to broadcast messages to other objects. If null, this class | |
902 will attempt to broadcast using the Messenger's default | |
903 instance.</param> | |
904 </member> | |
905 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Cleanup"> | |
906 <summary> | |
907 Unregisters this instance from the Messenger class. | |
908 <para>To cleanup additional resources, override this method, clean | |
909 up and then call base.Cleanup().</para> | |
910 </summary> | |
911 </member> | |
912 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Broadcast``1(``0,``0,System.String)"> | |
913 <summary> | |
914 Broadcasts a PropertyChangedMessage using either the instance of | |
915 the Messenger that was passed to this class (if available) | |
916 or the Messenger's default instance. | |
917 </summary> | |
918 <typeparam name="T">The type of the property that | |
919 changed.</typeparam> | |
920 <param name="oldValue">The value of the property before it | |
921 changed.</param> | |
922 <param name="newValue">The value of the property after it | |
923 changed.</param> | |
924 <param name="propertyName">The name of the property that | |
925 changed.</param> | |
926 </member> | |
927 <member name="M:GalaSoft.MvvmLight.ViewModelBase.RaisePropertyChanged``1(System.String,``0,``0,System.Boolean)"> | |
928 <summary> | |
929 Raises the PropertyChanged event if needed, and broadcasts a | |
930 PropertyChangedMessage using the Messenger instance (or the | |
931 static default instance if no Messenger instance is available). | |
932 </summary> | |
933 <typeparam name="T">The type of the property that | |
934 changed.</typeparam> | |
935 <param name="propertyName">The name of the property that | |
936 changed.</param> | |
937 <param name="oldValue">The property's value before the change | |
938 occurred.</param> | |
939 <param name="newValue">The property's value after the change | |
940 occurred.</param> | |
941 <param name="broadcast">If true, a PropertyChangedMessage will | |
942 be broadcasted. If false, only the event will be raised.</param> | |
943 <remarks>If the propertyName parameter | |
944 does not correspond to an existing property on the current class, an | |
945 exception is thrown in DEBUG configuration only.</remarks> | |
946 </member> | |
947 <member name="M:GalaSoft.MvvmLight.ViewModelBase.RaisePropertyChanged``1(System.Linq.Expressions.Expression{System.Func{``0}},``0,``0,System.Boolean)"> | |
948 <summary> | |
949 Raises the PropertyChanged event if needed, and broadcasts a | |
950 PropertyChangedMessage using the Messenger instance (or the | |
951 static default instance if no Messenger instance is available). | |
952 </summary> | |
953 <typeparam name="T">The type of the property that | |
954 changed.</typeparam> | |
955 <param name="propertyExpression">An expression identifying the property | |
956 that changed.</param> | |
957 <param name="oldValue">The property's value before the change | |
958 occurred.</param> | |
959 <param name="newValue">The property's value after the change | |
960 occurred.</param> | |
961 <param name="broadcast">If true, a PropertyChangedMessage will | |
962 be broadcasted. If false, only the event will be raised.</param> | |
963 </member> | |
964 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Set``1(System.Linq.Expressions.Expression{System.Func{``0}},``0@,``0,System.Boolean)"> | |
965 <summary> | |
966 Assigns a new value to the property. Then, raises the | |
967 PropertyChanged event if needed, and broadcasts a | |
968 PropertyChangedMessage using the Messenger instance (or the | |
969 static default instance if no Messenger instance is available). | |
970 </summary> | |
971 <typeparam name="T">The type of the property that | |
972 changed.</typeparam> | |
973 <param name="propertyExpression">An expression identifying the property | |
974 that changed.</param> | |
975 <param name="field">The field storing the property's value.</param> | |
976 <param name="newValue">The property's value after the change | |
977 occurred.</param> | |
978 <param name="broadcast">If true, a PropertyChangedMessage will | |
979 be broadcasted. If false, only the event will be raised.</param> | |
980 </member> | |
981 <member name="M:GalaSoft.MvvmLight.ViewModelBase.Set``1(System.String,``0@,``0,System.Boolean)"> | |
982 <summary> | |
983 Assigns a new value to the property. Then, raises the | |
984 PropertyChanged event if needed, and broadcasts a | |
985 PropertyChangedMessage using the Messenger instance (or the | |
986 static default instance if no Messenger instance is available). | |
987 </summary> | |
988 <typeparam name="T">The type of the property that | |
989 changed.</typeparam> | |
990 <param name="propertyName">The name of the property that | |
991 changed.</param> | |
992 <param name="field">The field storing the property's value.</param> | |
993 <param name="newValue">The property's value after the change | |
994 occurred.</param> | |
995 <param name="broadcast">If true, a PropertyChangedMessage will | |
996 be broadcasted. If false, only the event will be raised.</param> | |
997 </member> | |
998 <member name="P:GalaSoft.MvvmLight.ViewModelBase.IsInDesignMode"> | |
999 <summary> | |
1000 Gets a value indicating whether the control is in design mode | |
1001 (running under Blend or Visual Studio). | |
1002 </summary> | |
1003 </member> | |
1004 <member name="P:GalaSoft.MvvmLight.ViewModelBase.IsInDesignModeStatic"> | |
1005 <summary> | |
1006 Gets a value indicating whether the control is in design mode | |
1007 (running in Blend or Visual Studio). | |
1008 </summary> | |
1009 </member> | |
1010 <member name="P:GalaSoft.MvvmLight.ViewModelBase.MessengerInstance"> | |
1011 <summary> | |
1012 Gets or sets an instance of a <see cref="T:GalaSoft.MvvmLight.Messaging.IMessenger"/> used to | |
1013 broadcast messages to other objects. If null, this class will | |
1014 attempt to broadcast using the Messenger's default instance. | |
1015 </summary> | |
1016 </member> | |
1017 <member name="T:GalaSoft.MvvmLight.Helpers.WeakAction"> | |
1018 <summary> | |
1019 Stores an <see cref="P:GalaSoft.MvvmLight.Helpers.WeakAction.Action"/> without causing a hard reference | |
1020 to be created to the Action's owner. The owner can be garbage collected at any time. | |
1021 </summary> | |
1022 </member> | |
1023 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.#ctor(System.Object,System.Action)"> | |
1024 <summary> | |
1025 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Helpers.WeakAction"/> class. | |
1026 </summary> | |
1027 <param name="target">The action's owner.</param> | |
1028 <param name="action">The action that will be associated to this instance.</param> | |
1029 </member> | |
1030 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.Execute"> | |
1031 <summary> | |
1032 Executes the action. This only happens if the action's owner | |
1033 is still alive. | |
1034 </summary> | |
1035 </member> | |
1036 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction.MarkForDeletion"> | |
1037 <summary> | |
1038 Sets the reference that this instance stores to null. | |
1039 </summary> | |
1040 </member> | |
1041 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.Action"> | |
1042 <summary> | |
1043 Gets the Action associated to this instance. | |
1044 </summary> | |
1045 </member> | |
1046 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.IsAlive"> | |
1047 <summary> | |
1048 Gets a value indicating whether the Action's owner is still alive, or if it was collected | |
1049 by the Garbage Collector already. | |
1050 </summary> | |
1051 </member> | |
1052 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction.Target"> | |
1053 <summary> | |
1054 Gets the Action's owner. This object is stored as a <see cref="T:System.WeakReference"/>. | |
1055 </summary> | |
1056 </member> | |
1057 <member name="T:GalaSoft.MvvmLight.Helpers.WeakAction`1"> | |
1058 <summary> | |
1059 Stores an Action without causing a hard reference | |
1060 to be created to the Action's owner. The owner can be garbage collected at any time. | |
1061 </summary> | |
1062 <typeparam name="T">The type of the Action's parameter.</typeparam> | |
1063 </member> | |
1064 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.#ctor(System.Object,System.Action{`0})"> | |
1065 <summary> | |
1066 Initializes a new instance of the WeakAction class. | |
1067 </summary> | |
1068 <param name="target">The action's owner.</param> | |
1069 <param name="action">The action that will be associated to this instance.</param> | |
1070 </member> | |
1071 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.Execute"> | |
1072 <summary> | |
1073 Executes the action. This only happens if the action's owner | |
1074 is still alive. The action's parameter is set to default(T). | |
1075 </summary> | |
1076 </member> | |
1077 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.Execute(`0)"> | |
1078 <summary> | |
1079 Executes the action. This only happens if the action's owner | |
1080 is still alive. | |
1081 </summary> | |
1082 <param name="parameter">A parameter to be passed to the action.</param> | |
1083 </member> | |
1084 <member name="M:GalaSoft.MvvmLight.Helpers.WeakAction`1.ExecuteWithObject(System.Object)"> | |
1085 <summary> | |
1086 Executes the action with a parameter of type object. This parameter | |
1087 will be casted to T. This method implements <see cref="M:GalaSoft.MvvmLight.Helpers.IExecuteWithObject.ExecuteWithObject(System.Object)"/> | |
1088 and can be useful if you store multiple WeakAction{T} instances but don't know in advance | |
1089 what type T represents. | |
1090 </summary> | |
1091 <param name="parameter">The parameter that will be passed to the action after | |
1092 being casted to T.</param> | |
1093 </member> | |
1094 <member name="P:GalaSoft.MvvmLight.Helpers.WeakAction`1.Action"> | |
1095 <summary> | |
1096 Gets the Action associated to this instance. | |
1097 </summary> | |
1098 </member> | |
1099 <member name="T:GalaSoft.MvvmLight.Command.RelayCommand`1"> | |
1100 <summary> | |
1101 A generic command whose sole purpose is to relay its functionality to other | |
1102 objects by invoking delegates. The default return value for the CanExecute | |
1103 method is 'true'. This class allows you to accept command parameters in the | |
1104 Execute and CanExecute callback methods. | |
1105 </summary> | |
1106 <typeparam name="T">The type of the command parameter.</typeparam> | |
1107 </member> | |
1108 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.#ctor(System.Action{`0})"> | |
1109 <summary> | |
1110 Initializes a new instance of the RelayCommand class that | |
1111 can always execute. | |
1112 </summary> | |
1113 <param name="execute">The execution logic.</param> | |
1114 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1115 </member> | |
1116 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.#ctor(System.Action{`0},System.Func{`0,System.Boolean})"> | |
1117 <summary> | |
1118 Initializes a new instance of the RelayCommand class. | |
1119 </summary> | |
1120 <param name="execute">The execution logic.</param> | |
1121 <param name="canExecute">The execution status logic.</param> | |
1122 <exception cref="T:System.ArgumentNullException">If the execute argument is null.</exception> | |
1123 </member> | |
1124 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.RaiseCanExecuteChanged"> | |
1125 <summary> | |
1126 Raises the <see cref="E:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecuteChanged"/> event. | |
1127 </summary> | |
1128 </member> | |
1129 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecute(System.Object)"> | |
1130 <summary> | |
1131 Defines the method that determines whether the command can execute in its current state. | |
1132 </summary> | |
1133 <param name="parameter">Data used by the command. If the command does not require data | |
1134 to be passed, this object can be set to a null reference</param> | |
1135 <returns>true if this command can be executed; otherwise, false.</returns> | |
1136 </member> | |
1137 <member name="M:GalaSoft.MvvmLight.Command.RelayCommand`1.Execute(System.Object)"> | |
1138 <summary> | |
1139 Defines the method to be called when the command is invoked. | |
1140 </summary> | |
1141 <param name="parameter">Data used by the command. If the command does not require data | |
1142 to be passed, this object can be set to a null reference</param> | |
1143 </member> | |
1144 <member name="E:GalaSoft.MvvmLight.Command.RelayCommand`1.CanExecuteChanged"> | |
1145 <summary> | |
1146 Occurs when changes occur that affect whether the command should execute. | |
1147 </summary> | |
1148 </member> | |
1149 <member name="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"> | |
1150 <summary> | |
1151 Passes a string property name (PropertyName) and a generic value | |
1152 (<see cref="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.OldValue"/> and <see cref="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.NewValue"/>) to a recipient. | |
1153 This message type can be used to propagate a PropertyChanged event to | |
1154 a recipient using the messenging system. | |
1155 </summary> | |
1156 <typeparam name="T">The type of the OldValue and NewValue property.</typeparam> | |
1157 </member> | |
1158 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(System.Object,`0,`0,System.String)"> | |
1159 <summary> | |
1160 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1161 </summary> | |
1162 <param name="sender">The message's sender.</param> | |
1163 <param name="oldValue">The property's value before the change occurred.</param> | |
1164 <param name="newValue">The property's value after the change occurred.</param> | |
1165 <param name="propertyName">The name of the property that changed.</param> | |
1166 </member> | |
1167 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(`0,`0,System.String)"> | |
1168 <summary> | |
1169 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1170 </summary> | |
1171 <param name="oldValue">The property's value before the change occurred.</param> | |
1172 <param name="newValue">The property's value after the change occurred.</param> | |
1173 <param name="propertyName">The name of the property that changed.</param> | |
1174 </member> | |
1175 <member name="M:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.#ctor(System.Object,System.Object,`0,`0,System.String)"> | |
1176 <summary> | |
1177 Initializes a new instance of the <see cref="T:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1"/> class. | |
1178 </summary> | |
1179 <param name="sender">The message's sender.</param> | |
1180 <param name="target">The message's intended target. This parameter can be used | |
1181 to give an indication as to whom the message was intended for. Of course | |
1182 this is only an indication, amd may be null.</param> | |
1183 <param name="oldValue">The property's value before the change occurred.</param> | |
1184 <param name="newValue">The property's value after the change occurred.</param> | |
1185 <param name="propertyName">The name of the property that changed.</param> | |
1186 </member> | |
1187 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.NewValue"> | |
1188 <summary> | |
1189 Gets the value that the property has after the change. | |
1190 </summary> | |
1191 </member> | |
1192 <member name="P:GalaSoft.MvvmLight.Messaging.PropertyChangedMessage`1.OldValue"> | |
1193 <summary> | |
1194 Gets the value that the property had before the change. | |
1195 </summary> | |
1196 </member> | |
1197 <member name="T:GalaSoft.MvvmLight.Messaging.DialogMessage"> | |
1198 <summary> | |
1199 Use this class to send a message requesting to display a message box with features | |
1200 corresponding to this message's properties. The Callback property should be used | |
1201 to notify the message's sender about the user's choice in the message box. | |
1202 Typically, you can use this message typ's recipient will be an element of the View, | |
1203 and the sender will possibly be a ViewModel. | |
1204 </summary> | |
1205 </member> | |
1206 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1207 <summary> | |
1208 Initializes a new instance of the DialogMessage class. | |
1209 </summary> | |
1210 <param name="content">The text displayed by the message box.</param> | |
1211 <param name="callback">A callback method that should be executed to deliver the result | |
1212 of the message box to the object that sent the message.</param> | |
1213 </member> | |
1214 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.Object,System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1215 <summary> | |
1216 Initializes a new instance of the DialogMessage class. | |
1217 </summary> | |
1218 <param name="sender">The message's original sender.</param> | |
1219 <param name="content">The text displayed by the message box.</param> | |
1220 <param name="callback">A callback method that should be executed to deliver the result | |
1221 of the message box to the object that sent the message.</param> | |
1222 </member> | |
1223 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.#ctor(System.Object,System.Object,System.String,System.Action{System.Windows.MessageBoxResult})"> | |
1224 <summary> | |
1225 Initializes a new instance of the DialogMessage class. | |
1226 </summary> | |
1227 <param name="sender">The message's original sender.</param> | |
1228 <param name="target">The message's intended target. This parameter can be used | |
1229 to give an indication as to whom the message was intended for. Of course | |
1230 this is only an indication, amd may be null.</param> | |
1231 <param name="content">The text displayed by the message box.</param> | |
1232 <param name="callback">A callback method that should be executed to deliver the result | |
1233 of the message box to the object that sent the message.</param> | |
1234 </member> | |
1235 <member name="M:GalaSoft.MvvmLight.Messaging.DialogMessage.ProcessCallback(System.Windows.MessageBoxResult)"> | |
1236 <summary> | |
1237 Utility method, checks if the <see cref="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Callback"/> property is | |
1238 null, and if it is not null, executes it. | |
1239 </summary> | |
1240 <param name="result">The result that must be passed | |
1241 to the dialog message caller.</param> | |
1242 </member> | |
1243 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Button"> | |
1244 <summary> | |
1245 Gets or sets the buttons displayed by the message box. | |
1246 </summary> | |
1247 </member> | |
1248 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Callback"> | |
1249 <summary> | |
1250 Gets a callback method that should be executed to deliver the result | |
1251 of the message box to the object that sent the message. | |
1252 </summary> | |
1253 </member> | |
1254 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Caption"> | |
1255 <summary> | |
1256 Gets or sets the caption for the message box. | |
1257 </summary> | |
1258 </member> | |
1259 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.DefaultResult"> | |
1260 <summary> | |
1261 Gets or sets which result is the default in the message box. | |
1262 </summary> | |
1263 </member> | |
1264 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Icon"> | |
1265 <summary> | |
1266 Gets or sets the icon for the message box. | |
1267 </summary> | |
1268 </member> | |
1269 <member name="P:GalaSoft.MvvmLight.Messaging.DialogMessage.Options"> | |
1270 <summary> | |
1271 Gets or sets the options for the message box. | |
1272 </summary> | |
1273 </member> | |
1274 <member name="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"> | |
1275 <summary> | |
1276 Provides a message class with a built-in callback. When the recipient | |
1277 is done processing the message, it can execute the callback to | |
1278 notify the sender that it is done. Use the <see cref="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.Execute(`0)"/> | |
1279 method to execute the callback. The callback method has one parameter. | |
1280 <seealso cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction"/>. | |
1281 </summary> | |
1282 <typeparam name="TCallbackParameter">The type of the callback method's | |
1283 only parameter.</typeparam> | |
1284 </member> | |
1285 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.String,System.Action{`0})"> | |
1286 <summary> | |
1287 Initializes a new instance of the | |
1288 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
1289 </summary> | |
1290 <param name="notification">An arbitrary string that will be | |
1291 carried by the message.</param> | |
1292 <param name="callback">The callback method that can be executed | |
1293 by the recipient to notify the sender that the message has been | |
1294 processed.</param> | |
1295 </member> | |
1296 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.Object,System.String,System.Action{`0})"> | |
1297 <summary> | |
1298 Initializes a new instance of the | |
1299 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
1300 </summary> | |
1301 <param name="sender">The message's sender.</param> | |
1302 <param name="notification">An arbitrary string that will be | |
1303 carried by the message.</param> | |
1304 <param name="callback">The callback method that can be executed | |
1305 by the recipient to notify the sender that the message has been | |
1306 processed.</param> | |
1307 </member> | |
1308 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.#ctor(System.Object,System.Object,System.String,System.Action{`0})"> | |
1309 <summary> | |
1310 Initializes a new instance of the | |
1311 <see cref="T:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1"/> class. | |
1312 </summary> | |
1313 <param name="sender">The message's sender.</param> | |
1314 <param name="target">The message's intended target. This parameter can be used | |
1315 to give an indication as to whom the message was intended for. Of course | |
1316 this is only an indication, amd may be null.</param> | |
1317 <param name="notification">An arbitrary string that will be | |
1318 carried by the message.</param> | |
1319 <param name="callback">The callback method that can be executed | |
1320 by the recipient to notify the sender that the message has been | |
1321 processed.</param> | |
1322 </member> | |
1323 <member name="M:GalaSoft.MvvmLight.Messaging.NotificationMessageAction`1.Execute(`0)"> | |
1324 <summary> | |
1325 Executes the callback that was provided with the message. | |
1326 </summary> | |
1327 <param name="parameter">A parameter requested by the message's | |
1328 sender and providing additional information on the recipient's | |
1329 state.</param> | |
1330 </member> | |
1331 </members> | |
1332 </doc> |