GalaSoft.MvvmLight.Platform.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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.Threading.DispatcherHelper">
  8. <summary>
  9. Helper class for dispatcher operations on the UI thread.
  10. </summary>
  11. </member>
  12. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)">
  13. <summary>
  14. Executes an action on the UI thread. If this method is called
  15. from the UI thread, the action is executed immendiately. If the
  16. method is called from another thread, the action will be enqueued
  17. on the UI thread's dispatcher and executed asynchronously.
  18. <para>For additional operations on the UI thread, you can get a
  19. reference to the UI thread's dispatcher thanks to the property
  20. <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/></para>.
  21. </summary>
  22. <param name="action">The action that will be executed on the UI
  23. thread.</param>
  24. </member>
  25. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.RunAsync(System.Action)">
  26. <summary>
  27. Invokes an action asynchronously on the UI thread.
  28. </summary>
  29. <param name="action">The action that must be executed.</param>
  30. <returns>The object that provides handlers for the completed async event dispatch.</returns>
  31. </member>
  32. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize">
  33. <summary>
  34. This method should be called once on the UI thread to ensure that
  35. the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/> property is initialized.
  36. <para>In a Silverlight application, call this method in the
  37. Application_Startup event handler, after the MainPage is constructed.</para>
  38. <para>In WPF, call this method on the static App() constructor.</para>
  39. </summary>
  40. </member>
  41. <member name="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Reset">
  42. <summary>
  43. Resets the class by deleting the <see cref="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher"/>
  44. </summary>
  45. </member>
  46. <member name="P:GalaSoft.MvvmLight.Threading.DispatcherHelper.UIDispatcher">
  47. <summary>
  48. Gets a reference to the UI thread's dispatcher, after the
  49. <see cref="M:GalaSoft.MvvmLight.Threading.DispatcherHelper.Initialize"/> method has been called on the UI thread.
  50. </summary>
  51. </member>
  52. <member name="T:GalaSoft.MvvmLight.Views.DialogService">
  53. <summary>
  54. An implementation of <see cref="T:GalaSoft.MvvmLight.Views.IDialogService"/> allowing
  55. to display simple dialogs to the user. Note that this class
  56. uses the built in Android dialogs which may or may not
  57. be sufficient for your needs. Using this class is easy
  58. but feel free to develop your own IDialogService implementation
  59. if needed.
  60. </summary>
  61. </member>
  62. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.String,System.String,System.String,System.Action)">
  63. <summary>
  64. Displays information about an error.
  65. </summary>
  66. <param name="message">The message to be shown to the user.</param>
  67. <param name="title">The title of the dialog box. This may be null.</param>
  68. <param name="buttonText">The text shown in the only button
  69. in the dialog box. If left null, the text "OK" will be used.</param>
  70. <param name="afterHideCallback">A callback that should be executed after
  71. the dialog box is closed by the user.</param>
  72. <returns>A Task allowing this async method to be awaited.</returns>
  73. </member>
  74. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.Exception,System.String,System.String,System.Action)">
  75. <summary>
  76. Displays information about an error.
  77. </summary>
  78. <param name="error">The exception of which the message must be shown to the user.</param>
  79. <param name="title">The title of the dialog box. This may be null.</param>
  80. <param name="buttonText">The text shown in the only button
  81. in the dialog box. If left null, the text "OK" will be used.</param>
  82. <param name="afterHideCallback">A callback that should be executed after
  83. the dialog box is closed by the user.</param>
  84. <returns>A Task allowing this async method to be awaited.</returns>
  85. </member>
  86. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String)">
  87. <summary>
  88. Displays information to the user. The dialog box will have only
  89. one button with the text "OK".
  90. </summary>
  91. <param name="message">The message to be shown to the user.</param>
  92. <param name="title">The title of the dialog box. This may be null.</param>
  93. <returns>A Task allowing this async method to be awaited.</returns>
  94. </member>
  95. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.Action)">
  96. <summary>
  97. Displays information to the user. The dialog box will have only
  98. one button.
  99. </summary>
  100. <param name="message">The message to be shown to the user.</param>
  101. <param name="title">The title of the dialog box. This may be null.</param>
  102. <param name="buttonText">The text shown in the only button
  103. in the dialog box. If left null, the text "OK" will be used.</param>
  104. <param name="afterHideCallback">A callback that should be executed after
  105. the dialog box is closed by the user.</param>
  106. <returns>A Task allowing this async method to be awaited.</returns>
  107. </member>
  108. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.String,System.Action{System.Boolean})">
  109. <summary>
  110. Displays information to the user. The dialog box will have only
  111. one button.
  112. </summary>
  113. <param name="message">The message to be shown to the user.</param>
  114. <param name="title">The title of the dialog box. This may be null.</param>
  115. <param name="buttonConfirmText">The text shown in the "confirm" button
  116. in the dialog box. If left null, the text "OK" will be used.</param>
  117. <param name="buttonCancelText">The text shown in the "cancel" button
  118. in the dialog box. If left null, the text "Cancel" will be used.</param>
  119. <param name="afterHideCallback">A callback that should be executed after
  120. the dialog box is closed by the user. The callback method will get a boolean
  121. parameter indicating if the "confirm" button (true) or the "cancel" button
  122. (false) was pressed by the user.</param>
  123. <returns>A Task allowing this async method to be awaited.</returns>
  124. </member>
  125. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessageBox(System.String,System.String)">
  126. <summary>
  127. Displays information to the user in a simple dialog box. The dialog box will have only
  128. one button with the text "OK". This method should be used for debugging purposes.
  129. </summary>
  130. <param name="message">The message to be shown to the user.</param>
  131. <param name="title">The title of the dialog box. This may be null.</param>
  132. <returns>A Task allowing this async method to be awaited.</returns>
  133. </member>
  134. <member name="T:GalaSoft.MvvmLight.Views.NavigationService">
  135. <summary>
  136. Windows 8 and Windows Phone Application 8.1 implementation of <see cref="T:GalaSoft.MvvmLight.Views.INavigationService"/>.
  137. </summary>
  138. </member>
  139. <member name="F:GalaSoft.MvvmLight.Views.NavigationService.RootPageKey">
  140. <summary>
  141. The key that is returned by the <see cref="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey"/> property
  142. when the current Page is the root page.
  143. </summary>
  144. </member>
  145. <member name="F:GalaSoft.MvvmLight.Views.NavigationService.UnknownPageKey">
  146. <summary>
  147. The key that is returned by the <see cref="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey"/> property
  148. when the current Page is not found.
  149. This can be the case when the navigation wasn't managed by this NavigationService,
  150. for example when it is directly triggered in the code behind, and the
  151. NavigationService was not configured for this page type.
  152. </summary>
  153. </member>
  154. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GoBack">
  155. <summary>
  156. If possible, discards the current page and displays the previous page
  157. on the navigation stack.
  158. </summary>
  159. </member>
  160. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String)">
  161. <summary>
  162. Displays a new page corresponding to the given key.
  163. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)"/>
  164. method first.
  165. </summary>
  166. <param name="pageKey">The key corresponding to the page
  167. that should be displayed.</param>
  168. <exception cref="T:System.ArgumentException">When this method is called for
  169. a key that has not been configured earlier.</exception>
  170. </member>
  171. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String,System.Object)">
  172. <summary>
  173. Displays a new page corresponding to the given key,
  174. and passes a parameter to the new page.
  175. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)"/>
  176. method first.
  177. </summary>
  178. <param name="pageKey">The key corresponding to the page
  179. that should be displayed.</param>
  180. <param name="parameter">The parameter that should be passed
  181. to the new page.</param>
  182. <exception cref="T:System.ArgumentException">When this method is called for
  183. a key that has not been configured earlier.</exception>
  184. </member>
  185. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)">
  186. <summary>
  187. Adds a key/page pair to the navigation service.
  188. </summary>
  189. <param name="key">The key that will be used later
  190. 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>
  191. <param name="pageType">The type of the page corresponding to the key.</param>
  192. </member>
  193. <member name="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey">
  194. <summary>
  195. The key corresponding to the currently displayed page.
  196. </summary>
  197. </member>
  198. </members>
  199. </doc>