Caliburn.Micro.Platform.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Caliburn.Micro.Platform</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Caliburn.Micro.CaliburnApplicationDelegate">
  8. <summary>
  9. Encapsulates the app and its available services.
  10. </summary>
  11. </member>
  12. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.#ctor">
  13. <summary>
  14. Creates an instance of <see cref="T:Caliburn.Micro.CaliburnApplicationDelegate"/>.
  15. </summary>
  16. </member>
  17. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.#ctor(System.IntPtr)">
  18. <summary>
  19. Creates an instance of <see cref="T:Caliburn.Micro.CaliburnApplicationDelegate"/>.
  20. </summary>
  21. <param name="handle">/// The handle for this class</param>
  22. </member>
  23. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.#ctor(Foundation.NSObjectFlag)">
  24. <summary>
  25. Creates an instance of <see cref="T:Caliburn.Micro.CaliburnApplicationDelegate"/>.
  26. </summary>
  27. <param name="t">>Unused sentinel value, pass NSObjectFlag.Empty</param>
  28. </member>
  29. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.StartDesignTime">
  30. <summary>
  31. Called by the bootstrapper's constructor at design time to start the framework.
  32. </summary>
  33. </member>
  34. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.StartRuntime">
  35. <summary>
  36. Called by the bootstrapper's constructor at runtime to start the framework.
  37. </summary>B
  38. </member>
  39. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.Initialize">
  40. <summary>
  41. Start the framework.
  42. </summary>
  43. </member>
  44. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.Configure">
  45. <summary>
  46. Override to configure the framework and setup your IoC container.
  47. </summary>
  48. </member>
  49. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.SelectAssemblies">
  50. <summary>
  51. Override to tell the framework where to find assemblies to inspect for views, etc.
  52. </summary>
  53. <returns>A list of assemblies to inspect.</returns>
  54. </member>
  55. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.GetInstance(System.Type,System.String)">
  56. <summary>
  57. Override this to provide an IoC specific implementation.
  58. </summary>
  59. <param name="service">The service to locate.</param>
  60. <param name="key">The key to locate.</param>
  61. <returns>The located service.</returns>
  62. </member>
  63. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.GetAllInstances(System.Type)">
  64. <summary>
  65. Override this to provide an IoC specific implementation
  66. </summary>
  67. <param name="service">The service to locate.</param>
  68. <returns>The located services.</returns>
  69. </member>
  70. <member name="M:Caliburn.Micro.CaliburnApplicationDelegate.BuildUp(System.Object)">
  71. <summary>
  72. Override this to provide an IoC specific implementation.
  73. </summary>
  74. <param name="instance">The instance to perform injection on.</param>
  75. </member>
  76. <member name="T:Caliburn.Micro.IOSPlatformProvider">
  77. <summary>
  78. A <see cref="T:Caliburn.Micro.IPlatformProvider"/> implementation for the Xamarin iOS platfrom.
  79. </summary>
  80. </member>
  81. <member name="P:Caliburn.Micro.IOSPlatformProvider.InDesignMode">
  82. <summary>
  83. Indicates whether or not the framework is in design-time mode.
  84. </summary>
  85. </member>
  86. <member name="P:Caliburn.Micro.IOSPlatformProvider.PropertyChangeNotificationsOnUIThread">
  87. <summary>
  88. Whether or not classes should execute property change notications on the UI thread.
  89. </summary>
  90. </member>
  91. <member name="M:Caliburn.Micro.IOSPlatformProvider.BeginOnUIThread(System.Action)">
  92. <summary>
  93. Executes the action on the UI thread asynchronously.
  94. </summary>
  95. <param name="action">The action to execute.</param>
  96. </member>
  97. <member name="M:Caliburn.Micro.IOSPlatformProvider.OnUIThreadAsync(System.Func{System.Threading.Tasks.Task})">
  98. <summary>
  99. Executes the action on the UI thread asynchronously.
  100. </summary>
  101. <param name = "action">The action to execute.</param>
  102. </member>
  103. <member name="M:Caliburn.Micro.IOSPlatformProvider.OnUIThread(System.Action)">
  104. <summary>
  105. Executes the action on the UI thread.
  106. </summary>
  107. <param name = "action">The action to execute.</param>
  108. </member>
  109. <member name="M:Caliburn.Micro.IOSPlatformProvider.GetFirstNonGeneratedView(System.Object)">
  110. <summary>
  111. Used to retrieve the root, non-framework-created view.
  112. </summary>
  113. <param name="view">The view to search.</param>
  114. <returns>The root element that was not created by the framework.</returns>
  115. <remarks>In certain instances the services create UI elements.
  116. For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in.
  117. The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer.
  118. Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.
  119. </remarks>
  120. </member>
  121. <member name="M:Caliburn.Micro.IOSPlatformProvider.ExecuteOnFirstLoad(System.Object,System.Action{System.Object})">
  122. <summary>
  123. Executes the handler the fist time the view is loaded.
  124. </summary>
  125. <param name="view">The view.</param>
  126. <param name="handler">The handler.</param>
  127. </member>
  128. <member name="M:Caliburn.Micro.IOSPlatformProvider.ExecuteOnLayoutUpdated(System.Object,System.Action{System.Object})">
  129. <summary>
  130. Executes the handler the next time the view's LayoutUpdated event fires.
  131. </summary>
  132. <param name="view">The view.</param>
  133. <param name="handler">The handler.</param>
  134. </member>
  135. <member name="M:Caliburn.Micro.IOSPlatformProvider.GetViewCloseAction(System.Object,System.Collections.Generic.ICollection{System.Object},System.Nullable{System.Boolean})">
  136. <summary>
  137. Get the close action for the specified view model.
  138. </summary>
  139. <param name="viewModel">The view model to close.</param>
  140. <param name="views">The associated views.</param>
  141. <param name="dialogResult">The dialog result.</param>
  142. <returns>An <see cref="T:System.Action"/> to close the view model.</returns>
  143. </member>
  144. <member name="T:Caliburn.Micro.IUIViewController">
  145. <summary>
  146. An interface to allow the IOSPlatformProvider provide view lifecycle events
  147. </summary>
  148. </member>
  149. <member name="P:Caliburn.Micro.IUIViewController.IsViewLoaded">
  150. <summary>
  151. Returns if the current view is already loaded
  152. </summary>
  153. </member>
  154. <member name="E:Caliburn.Micro.IUIViewController.ViewLoaded">
  155. <summary>
  156. Invoked when the view is loaded
  157. </summary>
  158. </member>
  159. <member name="E:Caliburn.Micro.IUIViewController.ViewAppeared">
  160. <summary>
  161. Invoked the view appears
  162. </summary>
  163. </member>
  164. <member name="T:Caliburn.Micro.ViewModelLocator">
  165. <summary>
  166. A strategy for determining which view model to use for a given view.
  167. </summary>
  168. </member>
  169. <member name="F:Caliburn.Micro.ViewModelLocator.NameTransformer">
  170. <summary>
  171. Used to transform names.
  172. </summary>
  173. </member>
  174. <member name="F:Caliburn.Micro.ViewModelLocator.InterfaceCaptureGroupName">
  175. <summary>
  176. The name of the capture group used as a marker for rules that return interface types
  177. </summary>
  178. </member>
  179. <member name="M:Caliburn.Micro.ViewModelLocator.ConfigureTypeMappings(Caliburn.Micro.TypeMappingConfiguration)">
  180. <summary>
  181. Specifies how type mappings are created, including default type mappings. Calling this method will
  182. clear all existing name transformation rules and create new default type mappings according to the
  183. configuration.
  184. </summary>
  185. <param name="config">An instance of TypeMappingConfiguration that provides the settings for configuration</param>
  186. </member>
  187. <member name="M:Caliburn.Micro.ViewModelLocator.AddDefaultTypeMapping(System.String)">
  188. <summary>
  189. Adds a default type mapping using the standard namespace mapping convention
  190. </summary>
  191. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  192. </member>
  193. <member name="M:Caliburn.Micro.ViewModelLocator.AddTypeMapping(System.String,System.String,System.String[],System.String)">
  194. <summary>
  195. Adds a standard type mapping based on namespace RegEx replace and filter patterns
  196. </summary>
  197. <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
  198. <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
  199. <param name="nsTargetsRegEx">Array of RegEx replace values for target namespaces</param>
  200. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  201. </member>
  202. <member name="M:Caliburn.Micro.ViewModelLocator.AddTypeMapping(System.String,System.String,System.String,System.String)">
  203. <summary>
  204. Adds a standard type mapping based on namespace RegEx replace and filter patterns
  205. </summary>
  206. <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
  207. <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
  208. <param name="nsTargetRegEx">RegEx replace value for target namespace</param>
  209. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  210. </member>
  211. <member name="M:Caliburn.Micro.ViewModelLocator.AddNamespaceMapping(System.String,System.String[],System.String)">
  212. <summary>
  213. Adds a standard type mapping based on simple namespace mapping
  214. </summary>
  215. <param name="nsSource">Namespace of source type</param>
  216. <param name="nsTargets">Namespaces of target type as an array</param>
  217. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  218. </member>
  219. <member name="M:Caliburn.Micro.ViewModelLocator.AddNamespaceMapping(System.String,System.String,System.String)">
  220. <summary>
  221. Adds a standard type mapping based on simple namespace mapping
  222. </summary>
  223. <param name="nsSource">Namespace of source type</param>
  224. <param name="nsTarget">Namespace of target type</param>
  225. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  226. </member>
  227. <member name="M:Caliburn.Micro.ViewModelLocator.AddSubNamespaceMapping(System.String,System.String[],System.String)">
  228. <summary>
  229. Adds a standard type mapping by substituting one subnamespace for another
  230. </summary>
  231. <param name="nsSource">Subnamespace of source type</param>
  232. <param name="nsTargets">Subnamespaces of target type as an array</param>
  233. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  234. </member>
  235. <member name="M:Caliburn.Micro.ViewModelLocator.AddSubNamespaceMapping(System.String,System.String,System.String)">
  236. <summary>
  237. Adds a standard type mapping by substituting one subnamespace for another
  238. </summary>
  239. <param name="nsSource">Subnamespace of source type</param>
  240. <param name="nsTarget">Subnamespace of target type</param>
  241. <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
  242. </member>
  243. <member name="M:Caliburn.Micro.ViewModelLocator.MakeInterface(System.String)">
  244. <summary>
  245. Makes a type name into an interface name.
  246. </summary>
  247. <param name = "typeName">The part.</param>
  248. <returns></returns>
  249. </member>
  250. <member name="F:Caliburn.Micro.ViewModelLocator.TransformName">
  251. <summary>
  252. Transforms a View type name into all of its possible ViewModel type names. Accepts a flag
  253. to include or exclude interface types.
  254. </summary>
  255. <returns>Enumeration of transformed names</returns>
  256. <remarks>Arguments:
  257. typeName = The name of the View type being resolved to its companion ViewModel.
  258. includeInterfaces = Flag to indicate if interface types are included
  259. </remarks>
  260. </member>
  261. <member name="F:Caliburn.Micro.ViewModelLocator.LocateTypeForViewType">
  262. <summary>
  263. Determines the view model type based on the specified view type.
  264. </summary>
  265. <returns>The view model type.</returns>
  266. <remarks>
  267. Pass the view type and receive a view model type. Pass true for the second parameter to search for interfaces.
  268. </remarks>
  269. </member>
  270. <member name="F:Caliburn.Micro.ViewModelLocator.LocateForViewType">
  271. <summary>
  272. Locates the view model for the specified view type.
  273. </summary>
  274. <returns>The view model.</returns>
  275. <remarks>
  276. Pass the view type as a parameter and receive a view model instance.
  277. </remarks>
  278. </member>
  279. <member name="F:Caliburn.Micro.ViewModelLocator.LocateForView">
  280. <summary>
  281. Locates the view model for the specified view instance.
  282. </summary>
  283. <returns>The view model.</returns>
  284. <remarks>
  285. Pass the view instance as a parameters and receive a view model instance.
  286. </remarks>
  287. </member>
  288. </members>
  289. </doc>