GalaSoft.MvvmLight.WPF4.xml 92 KB

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