GalaSoft.MvvmLight.Platform.xml 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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.Command.EventToCommand">
  8. <summary>
  9. This <see cref="T:System.Windows.Interactivity.TriggerAction`1"/> can be
  10. used to bind any event on any FrameworkElement to an <see cref="T:System.Windows.Input.ICommand"/>.
  11. Typically, this element is used in XAML to connect the attached element
  12. to a command located in a ViewModel. This trigger can only be attached
  13. to a FrameworkElement or a class deriving from FrameworkElement.
  14. <para>To access the EventArgs of the fired event, use a RelayCommand&lt;EventArgs&gt;
  15. and leave the CommandParameter and CommandParameterValue empty!</para>
  16. </summary>
  17. </member>
  18. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameterPropertyName">
  19. <summary>
  20. The <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> dependency property's name.
  21. </summary>
  22. </member>
  23. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameterProperty">
  24. <summary>
  25. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter"/> dependency property
  26. </summary>
  27. </member>
  28. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.CommandProperty">
  29. <summary>
  30. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> dependency property
  31. </summary>
  32. </member>
  33. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabledProperty">
  34. <summary>
  35. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled"/> dependency property
  36. </summary>
  37. </member>
  38. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.OnAttached">
  39. <summary>
  40. Called when this trigger is attached to a FrameworkElement.
  41. </summary>
  42. </member>
  43. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.GetCommand">
  44. <summary>
  45. This method is here for compatibility
  46. with the Silverlight 3 version.
  47. </summary>
  48. <returns>The command that must be executed when
  49. this trigger is invoked.</returns>
  50. </member>
  51. <member name="F:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameterProperty">
  52. <summary>
  53. Identifies the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> dependency property.
  54. </summary>
  55. </member>
  56. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.Invoke">
  57. <summary>
  58. Provides a simple way to invoke this trigger programatically
  59. without any EventArgs.
  60. </summary>
  61. </member>
  62. <member name="M:GalaSoft.MvvmLight.Command.EventToCommand.Invoke(System.Object)">
  63. <summary>
  64. Executes the trigger.
  65. <para>To access the EventArgs of the fired event, use a RelayCommand&lt;EventArgs&gt;
  66. and leave the CommandParameter and CommandParameterValue empty!</para>
  67. </summary>
  68. <param name="parameter">The EventArgs of the fired event.</param>
  69. </member>
  70. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.Command">
  71. <summary>
  72. Gets or sets the ICommand that this trigger is bound to. This
  73. is a DependencyProperty.
  74. </summary>
  75. </member>
  76. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter">
  77. <summary>
  78. Gets or sets an object that will be passed to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/>
  79. attached to this trigger. This is a DependencyProperty.
  80. </summary>
  81. </member>
  82. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameterValue">
  83. <summary>
  84. Gets or sets an object that will be passed to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/>
  85. attached to this trigger. This property is here for compatibility
  86. with the Silverlight version. This is NOT a DependencyProperty.
  87. For databinding, use the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.CommandParameter"/> property.
  88. </summary>
  89. </member>
  90. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled">
  91. <summary>
  92. Gets or sets a value indicating whether the attached element must be
  93. disabled when the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> property's CanExecuteChanged
  94. event fires. If this property is true, and the command's CanExecute
  95. method returns false, the element will be disabled. If this property
  96. is false, the element will not be disabled when the command's
  97. CanExecute method changes. This is a DependencyProperty.
  98. </summary>
  99. </member>
  100. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabledValue">
  101. <summary>
  102. Gets or sets a value indicating whether the attached element must be
  103. disabled when the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.Command"/> property's CanExecuteChanged
  104. event fires. If this property is true, and the command's CanExecute
  105. method returns false, the element will be disabled. This property is here for
  106. compatibility with the Silverlight version. This is NOT a DependencyProperty.
  107. For databinding, use the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.MustToggleIsEnabled"/> property.
  108. </summary>
  109. </member>
  110. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand">
  111. <summary>
  112. Specifies whether the EventArgs of the event that triggered this
  113. action should be passed to the bound RelayCommand. If this is true,
  114. the command should accept arguments of the corresponding
  115. type (for example RelayCommand&lt;MouseButtonEventArgs&gt;).
  116. </summary>
  117. </member>
  118. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverter">
  119. <summary>
  120. Gets or sets a converter used to convert the EventArgs when using
  121. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/>. If PassEventArgsToCommand is false,
  122. this property is never used.
  123. </summary>
  124. </member>
  125. <member name="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter">
  126. <summary>
  127. Gets or sets a parameters for the converter used to convert the EventArgs when using
  128. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/>. If PassEventArgsToCommand is false,
  129. this property is never used. This is a dependency property.
  130. </summary>
  131. </member>
  132. <member name="T:GalaSoft.MvvmLight.Command.IEventArgsConverter">
  133. <summary>
  134. The definition of the converter used to convert an EventArgs
  135. in the <see cref="T:GalaSoft.MvvmLight.Command.EventToCommand"/> class, if the
  136. <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.PassEventArgsToCommand"/> property is true.
  137. Set an instance of this class to the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverter"/>
  138. property of the EventToCommand instance.
  139. </summary>
  140. </member>
  141. <member name="M:GalaSoft.MvvmLight.Command.IEventArgsConverter.Convert(System.Object,System.Object)">
  142. <summary>
  143. The method used to convert the EventArgs instance.
  144. </summary>
  145. <param name="value">An instance of EventArgs passed by the
  146. event that the EventToCommand instance is handling.</param>
  147. <param name="parameter">An optional parameter used for the conversion. Use
  148. the <see cref="P:GalaSoft.MvvmLight.Command.EventToCommand.EventArgsConverterParameter"/> property
  149. to set this value. This may be null.</param>
  150. <returns>The converted value.</returns>
  151. </member>
  152. <member name="T:GalaSoft.MvvmLight.Threading.DispatcherHelper">
  153. <summary>
  154. Helper class for dispatcher operations on the UI thread.
  155. </summary>
  156. </member>
  157. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)">
  158. <summary>
  159. Executes an action on the UI thread. If this method is called
  160. from the UI thread, the action is executed immendiately. If the
  161. method is called from another thread, the action will be enqueued
  162. on the UI thread's dispatcher and executed asynchronously.
  163. <para>For additional operations on the UI thread, you can get a
  164. reference to the UI thread's dispatcher thanks to the property
  165. <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/></para>.
  166. </summary>
  167. <param name="action">The action that will be executed on the UI
  168. thread.</param>
  169. </member>
  170. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.RunAsync(System.Action)">
  171. <summary>
  172. Invokes an action asynchronously on the UI thread.
  173. </summary>
  174. <param name="action">The action that must be executed.</param>
  175. <returns>An object, which is returned immediately after BeginInvoke is called, that can be used to interact
  176. with the delegate as it is pending execution in the event queue.</returns>
  177. </member>
  178. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize">
  179. <summary>
  180. This method should be called once on the UI thread to ensure that
  181. the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/> property is initialized.
  182. <para>In a Silverlight application, call this method in the
  183. Application_Startup event handler, after the MainPage is constructed.</para>
  184. <para>In WPF, call this method on the static App() constructor.</para>
  185. </summary>
  186. </member>
  187. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Reset">
  188. <summary>
  189. Resets the class by deleting the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/>
  190. </summary>
  191. </member>
  192. <member name="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher">
  193. <summary>
  194. Gets a reference to the UI thread's dispatcher, after the
  195. <see cref="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"/> method has been called on the UI thread.
  196. </summary>
  197. </member>
  198. <member name="T:GalaSoft.MvvmLight.Views.DialogService">
  199. <summary>
  200. An implementation of <see cref="T:GalaSoft.MvvmLight.Views.IDialogService"/> allowing
  201. to display simple dialogs to the user. Note that this class
  202. uses the built in Windows Phone dialogs which may or may not
  203. be sufficient for your needs. Using this class is easy
  204. but feel free to develop your own IDialogService implementation
  205. if needed.
  206. </summary>
  207. </member>
  208. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.String,System.String,System.String,System.Action)">
  209. <summary>
  210. Displays information about an error.
  211. </summary>
  212. <param name="message">The message to be shown to the user.</param>
  213. <param name="title">The title of the dialog box. This may be null.</param>
  214. <param name="buttonText">The text shown in the only button
  215. in the dialog box. If left null, the text "OK" will be used.</param>
  216. <param name="afterHideCallback">A callback that should be executed after
  217. the dialog box is closed by the user.</param>
  218. <returns>A Task allowing this async method to be awaited.</returns>
  219. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  220. this method will be executed synchronously even though it can be awaited
  221. for cross-platform compatibility purposes.</remarks>
  222. </member>
  223. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.Exception,System.String,System.String,System.Action)">
  224. <summary>
  225. Displays information about an error.
  226. </summary>
  227. <param name="error">The exception of which the message must be shown to the user.</param>
  228. <param name="title">The title of the dialog box. This may be null.</param>
  229. <param name="buttonText">The text shown in the only button
  230. in the dialog box. If left null, the text "OK" will be used.</param>
  231. <param name="afterHideCallback">A callback that should be executed after
  232. the dialog box is closed by the user.</param>
  233. <returns>A Task allowing this async method to be awaited.</returns>
  234. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  235. this method will be executed synchronously even though it can be awaited
  236. for cross-platform compatibility purposes.</remarks>
  237. </member>
  238. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String)">
  239. <summary>
  240. Displays information to the user. The dialog box will have only
  241. one button with the text "OK".
  242. </summary>
  243. <param name="message">The message to be shown to the user.</param>
  244. <param name="title">The title of the dialog box. This may be null.</param>
  245. <returns>A Task allowing this async method to be awaited.</returns>
  246. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  247. this method will be executed synchronously even though it can be awaited
  248. for cross-platform compatibility purposes.</remarks>
  249. </member>
  250. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.Action)">
  251. <summary>
  252. Displays information to the user. The dialog box will have only
  253. one button.
  254. </summary>
  255. <param name="message">The message to be shown to the user.</param>
  256. <param name="title">The title of the dialog box. This may be null.</param>
  257. <param name="buttonText">The text shown in the only button
  258. in the dialog box. If left null, the text "OK" will be used.</param>
  259. <param name="afterHideCallback">A callback that should be executed after
  260. the dialog box is closed by the user.</param>
  261. <returns>A Task allowing this async method to be awaited.</returns>
  262. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  263. this method will be executed synchronously even though it can be awaited
  264. for cross-platform compatibility purposes.</remarks>
  265. </member>
  266. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.String,System.Action{System.Boolean})">
  267. <summary>
  268. Displays information to the user. The dialog box will have only
  269. one button.
  270. </summary>
  271. <param name="message">The message to be shown to the user.</param>
  272. <param name="title">The title of the dialog box. This may be null.</param>
  273. <param name="buttonConfirmText">The text shown in the "confirm" button
  274. in the dialog box. If left null, the text "OK" will be used.</param>
  275. <param name="buttonCancelText">The text shown in the "cancel" button
  276. in the dialog box. If left null, the text "Cancel" will be used.</param>
  277. <param name="afterHideCallback">A callback that should be executed after
  278. the dialog box is closed by the user. The callback method will get a boolean
  279. parameter indicating if the "confirm" button (true) or the "cancel" button
  280. (false) was pressed by the user.</param>
  281. <returns>A Task allowing this async method to be awaited. The task will return
  282. true or false depending on the dialog result.</returns>
  283. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  284. this method will be executed synchronously even though it can be awaited
  285. for cross-platform compatibility purposes.</remarks>
  286. </member>
  287. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessageBox(System.String,System.String)">
  288. <summary>
  289. Displays information to the user in a simple dialog box. The dialog box will have only
  290. one button with the text "OK". This method should be used for debugging purposes.
  291. </summary>
  292. <param name="message">The message to be shown to the user.</param>
  293. <param name="title">The title of the dialog box. This may be null.</param>
  294. <returns>A Task allowing this async method to be awaited.</returns>
  295. <remarks>Displaying dialogs in Windows Phone is synchronous. As such,
  296. this method will be executed synchronously even though it can be awaited
  297. for cross-platform compatibility purposes.</remarks>
  298. </member>
  299. <member name="T:GalaSoft.MvvmLight.Views.NavigationService">
  300. <summary>
  301. Windows Phone Silverlight implementation of <see cref="T:GalaSoft.MvvmLight.Views.INavigationService"/>.
  302. This implementation can be used in Windows Phone applications (not Xamarin Forms).
  303. </summary>
  304. </member>
  305. <member name="F:GalaSoft.MvvmLight.Views.NavigationService.RootPageKey">
  306. <summary>
  307. The key that is returned by the <see cref="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey"/> property
  308. when the current Page is the root page.
  309. </summary>
  310. </member>
  311. <member name="F:GalaSoft.MvvmLight.Views.NavigationService.ParameterKeyName">
  312. <summary>
  313. Use this key name to retrieve the navigation parameter.
  314. </summary>
  315. </member>
  316. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GoBack">
  317. <summary>
  318. If possible, discards the current page and displays the previous page
  319. on the navigation stack.
  320. </summary>
  321. </member>
  322. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String)">
  323. <summary>
  324. Displays a new page corresponding to the given key.
  325. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Uri)"/> method first.
  326. </summary>
  327. <param name="pageKey">The key corresponding to the page
  328. that should be displayed.</param>
  329. <exception cref="T:System.ArgumentException">When this method is called for
  330. a key that has not been configured earlier.</exception>
  331. </member>
  332. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String,System.Object)">
  333. <summary>
  334. Displays a new page corresponding to the given key,
  335. and passes a parameter to the new page.
  336. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Uri)"/> method first.
  337. </summary>
  338. <param name="pageKey">The key corresponding to the page
  339. that should be displayed.</param>
  340. <param name="parameter">The parameter that should be passed
  341. to the new page.</param>
  342. <exception cref="T:System.ArgumentException">When this method is called for
  343. a key that has not been configured earlier.</exception>
  344. </member>
  345. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Uri)">
  346. <summary>
  347. Adds a key/page pair to the navigation service.
  348. </summary>
  349. <param name="key">The key that will be used later
  350. in the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String)"/> or <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String,System.Object)"/> methods.</param>
  351. <param name="targetUri">The URI of the page corresponding to the key.</param>
  352. </member>
  353. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GetAndRemoveParameter(System.Windows.Navigation.NavigationContext)">
  354. <summary>
  355. Allows a caller to get the navigation parameter corresponding
  356. to the NavigationContext parameter.
  357. </summary>
  358. <param name="context">The <see cref="T:System.Windows.Navigation.NavigationContext"/>
  359. of the navigated page.</param>
  360. <returns>The navigation parameter. If no parameter is found,
  361. returns null.</returns>
  362. </member>
  363. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GetAndRemoveParameter``1(System.Windows.Navigation.NavigationContext)">
  364. <summary>
  365. Allows a caller to get the navigation parameter corresponding
  366. to the NavigationContext parameter.
  367. </summary>
  368. <typeparam name="T">The type of the retrieved parameter.</typeparam>
  369. <param name="context">The <see cref="T:System.Windows.Navigation.NavigationContext"/>
  370. of the navigated page.</param>
  371. <returns>The navigation parameter casted to the proper type.
  372. If no parameter is found, returns default(T).</returns>
  373. </member>
  374. <member name="E:GalaSoft.MvvmLight.Views.NavigationService.Navigated">
  375. <summary>
  376. Occurs when a page navigation has happened.
  377. </summary>
  378. </member>
  379. <member name="E:GalaSoft.MvvmLight.Views.NavigationService.Navigating">
  380. <summary>
  381. Occurs when a page navigation is going to happen.
  382. </summary>
  383. </member>
  384. <member name="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey">
  385. <summary>
  386. The key corresponding to the currently displayed page.
  387. </summary>
  388. </member>
  389. </members>
  390. </doc>