GalaSoft.MvvmLight.xml 96 KB

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