GalaSoft.MvvmLight.Platform.xml 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>GalaSoft.MvvmLight.Platform</name>
  5. </assembly>
  6. <members>
  7. <member name="T:GalaSoft.MvvmLight.CommandWpf.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.CommandWpf.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.CommandWpf.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.CommandWpf.RelayCommand.RaiseCanExecuteChanged">
  36. <summary>
  37. Raises the <see cref="E:GalaSoft.MvvmLight.CommandWpf.RelayCommand.CanExecuteChanged"/> event.
  38. </summary>
  39. </member>
  40. <member name="M:GalaSoft.MvvmLight.CommandWpf.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.CommandWpf.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.CommandWpf.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.CommandWpf.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.CommandWpf.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.CommandWpf.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.CommandWpf.RelayCommand`1.RaiseCanExecuteChanged">
  88. <summary>
  89. Raises the <see cref="E:GalaSoft.MvvmLight.CommandWpf.RelayCommand`1.CanExecuteChanged"/> event.
  90. </summary>
  91. </member>
  92. <member name="M:GalaSoft.MvvmLight.CommandWpf.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.CommandWpf.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.CommandWpf.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.Command.EventToCommand">
  113. <summary>
  114. This <see cref="T:System.Windows.Interactivity.TriggerAction`1"/> can be
  115. used to bind any event on any FrameworkElement to an <see cref="T:System.Windows.Input.ICommand"/>.
  116. Typically, this element is used in XAML to connect the attached element
  117. to a command located in a ViewModel. This trigger can only be attached
  118. to a FrameworkElement or a class deriving from FrameworkElement.
  119. <para>To access the EventArgs of the fired event, use a RelayCommand&lt;EventArgs&gt;
  120. and leave the CommandParameter and CommandParameterValue empty!</para>
  121. </summary>
  122. </member>
  123. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameterPropertyName">
  124. <summary>
  125. The <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> dependency property's name.
  126. </summary>
  127. </member>
  128. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameterProperty">
  129. <summary>
  130. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter"/> dependency property
  131. </summary>
  132. </member>
  133. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.CommandProperty">
  134. <summary>
  135. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> dependency property
  136. </summary>
  137. </member>
  138. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabledProperty">
  139. <summary>
  140. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled"/> dependency property
  141. </summary>
  142. </member>
  143. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.OnAttached">
  144. <summary>
  145. Called when this trigger is attached to a FrameworkElement.
  146. </summary>
  147. </member>
  148. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.GetAssociatedObject">
  149. <summary>
  150. This method is here for compatibility
  151. with the Silverlight version.
  152. </summary>
  153. <returns>The FrameworkElement to which this trigger
  154. is attached.</returns>
  155. </member>
  156. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.GetCommand">
  157. <summary>
  158. This method is here for compatibility
  159. with the Silverlight 3 version.
  160. </summary>
  161. <returns>The command that must be executed when
  162. this trigger is invoked.</returns>
  163. </member>
  164. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameterProperty">
  165. <summary>
  166. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> dependency property.
  167. </summary>
  168. </member>
  169. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.Invoke">
  170. <summary>
  171. Provides a simple way to invoke this trigger programatically
  172. without any EventArgs.
  173. </summary>
  174. </member>
  175. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.Invoke(System.Object)">
  176. <summary>
  177. Executes the trigger.
  178. <para>To access the EventArgs of the fired event, use a RelayCommand&lt;EventArgs&gt;
  179. and leave the CommandParameter and CommandParameterValue empty!</para>
  180. </summary>
  181. <param name="parameter">The EventArgs of the fired event.</param>
  182. </member>
  183. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.Command">
  184. <summary>
  185. Gets or sets the ICommand that this trigger is bound to. This
  186. is a DependencyProperty.
  187. </summary>
  188. </member>
  189. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter">
  190. <summary>
  191. Gets or sets an object that will be passed to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/>
  192. attached to this trigger. This is a DependencyProperty.
  193. </summary>
  194. </member>
  195. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameterValue">
  196. <summary>
  197. Gets or sets an object that will be passed to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/>
  198. attached to this trigger. This property is here for compatibility
  199. with the Silverlight version. This is NOT a DependencyProperty.
  200. For databinding, use the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter"/> property.
  201. </summary>
  202. </member>
  203. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled">
  204. <summary>
  205. Gets or sets a value indicating whether the attached element must be
  206. disabled when the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> property's CanExecuteChanged
  207. event fires. If this property is true, and the command's CanExecute
  208. method returns false, the element will be disabled. If this property
  209. is false, the element will not be disabled when the command's
  210. CanExecute method changes. This is a DependencyProperty.
  211. </summary>
  212. </member>
  213. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabledValue">
  214. <summary>
  215. Gets or sets a value indicating whether the attached element must be
  216. disabled when the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> property's CanExecuteChanged
  217. event fires. If this property is true, and the command's CanExecute
  218. method returns false, the element will be disabled. This property is here for
  219. compatibility with the Silverlight version. This is NOT a DependencyProperty.
  220. For databinding, use the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled"/> property.
  221. </summary>
  222. </member>
  223. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand">
  224. <summary>
  225. Specifies whether the EventArgs of the event that triggered this
  226. action should be passed to the bound RelayCommand. If this is true,
  227. the command should accept arguments of the corresponding
  228. type (for example RelayCommand&lt;MouseButtonEventArgs&gt;).
  229. </summary>
  230. </member>
  231. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverter">
  232. <summary>
  233. Gets or sets a converter used to convert the EventArgs when using
  234. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/>. If PassEventArgsToCommand is false,
  235. this property is never used.
  236. </summary>
  237. </member>
  238. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter">
  239. <summary>
  240. Gets or sets a parameters for the converter used to convert the EventArgs when using
  241. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/>. If PassEventArgsToCommand is false,
  242. this property is never used. This is a dependency property.
  243. </summary>
  244. </member>
  245. <member name="T:GalaSoft.MvvmLight.Command.IEventArgsConverter">
  246. <summary>
  247. The definition of the converter used to convert an EventArgs
  248. in the <see cref="T:GalaSoft.MvvmLight.Command.EventToCommand"/> class, if the
  249. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/> property is true.
  250. Set an instance of this class to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverter"/>
  251. property of the EventToCommand instance.
  252. </summary>
  253. </member>
  254. <member name="M:GalaSoft.MvvmLight.Command.IEventArgsConverter.Convert(System.Object,System.Object)">
  255. <summary>
  256. The method used to convert the EventArgs instance.
  257. </summary>
  258. <param name="value">An instance of EventArgs passed by the
  259. event that the EventToCommand instance is handling.</param>
  260. <param name="parameter">An optional parameter used for the conversion. Use
  261. the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> property
  262. to set this value. This may be null.</param>
  263. <returns>The converted value.</returns>
  264. </member>
  265. <member name="T:GalaSoft.MvvmLight.Threading.DispatcherHelper">
  266. <summary>
  267. Helper class for dispatcher operations on the UI thread.
  268. </summary>
  269. </member>
  270. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)">
  271. <summary>
  272. Executes an action on the UI thread. If this method is called
  273. from the UI thread, the action is executed immendiately. If the
  274. method is called from another thread, the action will be enqueued
  275. on the UI thread's dispatcher and executed asynchronously.
  276. <para>For additional operations on the UI thread, you can get a
  277. reference to the UI thread's dispatcher thanks to the property
  278. <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/></para>.
  279. </summary>
  280. <param name="action">The action that will be executed on the UI
  281. thread.</param>
  282. </member>
  283. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.RunAsync(System.Action)">
  284. <summary>
  285. Invokes an action asynchronously on the UI thread.
  286. </summary>
  287. <param name="action">The action that must be executed.</param>
  288. <returns>An object, which is returned immediately after BeginInvoke is called, that can be used to interact
  289. with the delegate as it is pending execution in the event queue.</returns>
  290. </member>
  291. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize">
  292. <summary>
  293. This method should be called once on the UI thread to ensure that
  294. the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/> property is initialized.
  295. <para>In a Silverlight application, call this method in the
  296. Application_Startup event handler, after the MainPage is constructed.</para>
  297. <para>In WPF, call this method on the static App() constructor.</para>
  298. </summary>
  299. </member>
  300. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Reset">
  301. <summary>
  302. Resets the class by deleting the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/>
  303. </summary>
  304. </member>
  305. <member name="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher">
  306. <summary>
  307. Gets a reference to the UI thread's dispatcher, after the
  308. <see cref="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"/> method has been called on the UI thread.
  309. </summary>
  310. </member>
  311. </members>
  312. </doc>