GalaSoft.MvvmLight.xml 96 KB

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