GalaSoft.MvvmLight.Extras.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>GalaSoft.MvvmLight.Extras</name>
  5. </assembly>
  6. <members>
  7. <member name="T:GalaSoft.MvvmLight.Ioc.ISimpleIoc">
  8. <summary>
  9. A very simple IOC container with basic functionality needed to register and resolve
  10. instances. If needed, this class can be replaced by another more elaborate
  11. IOC container implementing the IServiceLocator interface.
  12. The inspiration for this class is at https://gist.github.com/716137 but it has
  13. been extended with additional features.
  14. </summary>
  15. </member>
  16. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.ContainsCreated``1">
  17. <summary>
  18. Checks whether at least one instance of a given class is already created in the container.
  19. </summary>
  20. <typeparam name="TClass">The class that is queried.</typeparam>
  21. <returns>True if at least on instance of the class is already created, false otherwise.</returns>
  22. </member>
  23. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.ContainsCreated``1(System.String)">
  24. <summary>
  25. Checks whether the instance with the given key is already created for a given class
  26. in the container.
  27. </summary>
  28. <typeparam name="TClass">The class that is queried.</typeparam>
  29. <param name="key">The key that is queried.</param>
  30. <returns>True if the instance with the given key is already registered for the given class,
  31. false otherwise.</returns>
  32. </member>
  33. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.IsRegistered``1">
  34. <summary>
  35. Gets a value indicating whether a given type T is already registered.
  36. </summary>
  37. <typeparam name="T">The type that the method checks for.</typeparam>
  38. <returns>True if the type is registered, false otherwise.</returns>
  39. </member>
  40. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.IsRegistered``1(System.String)">
  41. <summary>
  42. Gets a value indicating whether a given type T and a give key
  43. are already registered.
  44. </summary>
  45. <typeparam name="T">The type that the method checks for.</typeparam>
  46. <param name="key">The key that the method checks for.</param>
  47. <returns>True if the type and key are registered, false otherwise.</returns>
  48. </member>
  49. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``2">
  50. <summary>
  51. Registers a given type for a given interface.
  52. </summary>
  53. <typeparam name="TInterface">The interface for which instances will be resolved.</typeparam>
  54. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  55. </member>
  56. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``2(System.Boolean)">
  57. <summary>
  58. Registers a given type for a given interface with the possibility for immediate
  59. creation of the instance.
  60. </summary>
  61. <typeparam name="TInterface">The interface for which instances will be resolved.</typeparam>
  62. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  63. <param name="createInstanceImmediately">If true, forces the creation of the default
  64. instance of the provided class.</param>
  65. </member>
  66. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1">
  67. <summary>
  68. Registers a given type.
  69. </summary>
  70. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  71. </member>
  72. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1(System.Boolean)">
  73. <summary>
  74. Registers a given type with the possibility for immediate
  75. creation of the instance.
  76. </summary>
  77. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  78. <param name="createInstanceImmediately">If true, forces the creation of the default
  79. instance of the provided class.</param>
  80. </member>
  81. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1(System.Func{``0})">
  82. <summary>
  83. Registers a given instance for a given type.
  84. </summary>
  85. <typeparam name="TClass">The type that is being registered.</typeparam>
  86. <param name="factory">The factory method able to create the instance that
  87. must be returned when the given type is resolved.</param>
  88. </member>
  89. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1(System.Func{``0},System.Boolean)">
  90. <summary>
  91. Registers a given instance for a given type with the possibility for immediate
  92. creation of the instance.
  93. </summary>
  94. <typeparam name="TClass">The type that is being registered.</typeparam>
  95. <param name="factory">The factory method able to create the instance that
  96. must be returned when the given type is resolved.</param>
  97. <param name="createInstanceImmediately">If true, forces the creation of the default
  98. instance of the provided class.</param>
  99. </member>
  100. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1(System.Func{``0},System.String)">
  101. <summary>
  102. Registers a given instance for a given type and a given key.
  103. </summary>
  104. <typeparam name="TClass">The type that is being registered.</typeparam>
  105. <param name="factory">The factory method able to create the instance that
  106. must be returned when the given type is resolved.</param>
  107. <param name="key">The key for which the given instance is registered.</param>
  108. </member>
  109. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Register``1(System.Func{``0},System.String,System.Boolean)">
  110. <summary>
  111. Registers a given instance for a given type and a given key with the possibility for immediate
  112. creation of the instance.
  113. </summary>
  114. <typeparam name="TClass">The type that is being registered.</typeparam>
  115. <param name="factory">The factory method able to create the instance that
  116. must be returned when the given type is resolved.</param>
  117. <param name="key">The key for which the given instance is registered.</param>
  118. <param name="createInstanceImmediately">If true, forces the creation of the default
  119. instance of the provided class.</param>
  120. </member>
  121. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Reset">
  122. <summary>
  123. Resets the instance in its original states. This deletes all the
  124. registrations.
  125. </summary>
  126. </member>
  127. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Unregister``1">
  128. <summary>
  129. Unregisters a class from the cache and removes all the previously
  130. created instances.
  131. </summary>
  132. <typeparam name="TClass">The class that must be removed.</typeparam>
  133. </member>
  134. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Unregister``1(``0)">
  135. <summary>
  136. Removes the given instance from the cache. The class itself remains
  137. registered and can be used to create other instances.
  138. </summary>
  139. <typeparam name="TClass">The type of the instance to be removed.</typeparam>
  140. <param name="instance">The instance that must be removed.</param>
  141. </member>
  142. <member name="M:GalaSoft.MvvmLight.Ioc.ISimpleIoc.Unregister``1(System.String)">
  143. <summary>
  144. Removes the instance corresponding to the given key from the cache. The class itself remains
  145. registered and can be used to create other instances.
  146. </summary>
  147. <typeparam name="TClass">The type of the instance to be removed.</typeparam>
  148. <param name="key">The key corresponding to the instance that must be removed.</param>
  149. </member>
  150. <member name="T:GalaSoft.MvvmLight.Ioc.PreferredConstructorAttribute">
  151. <summary>
  152. When used with the SimpleIoc container, specifies which constructor
  153. should be used to instantiate when GetInstance is called.
  154. If there is only one constructor in the class, this attribute is
  155. not needed.
  156. </summary>
  157. </member>
  158. <member name="T:GalaSoft.MvvmLight.Ioc.SimpleIoc">
  159. <summary>
  160. A very simple IOC container with basic functionality needed to register and resolve
  161. instances. If needed, this class can be replaced by another more elaborate
  162. IOC container implementing the IServiceLocator interface.
  163. The inspiration for this class is at https://gist.github.com/716137 but it has
  164. been extended with additional features.
  165. </summary>
  166. </member>
  167. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.ContainsCreated``1">
  168. <summary>
  169. Checks whether at least one instance of a given class is already created in the container.
  170. </summary>
  171. <typeparam name="TClass">The class that is queried.</typeparam>
  172. <returns>True if at least on instance of the class is already created, false otherwise.</returns>
  173. </member>
  174. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.ContainsCreated``1(System.String)">
  175. <summary>
  176. Checks whether the instance with the given key is already created for a given class
  177. in the container.
  178. </summary>
  179. <typeparam name="TClass">The class that is queried.</typeparam>
  180. <param name="key">The key that is queried.</param>
  181. <returns>True if the instance with the given key is already registered for the given class,
  182. false otherwise.</returns>
  183. </member>
  184. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.IsRegistered``1">
  185. <summary>
  186. Gets a value indicating whether a given type T is already registered.
  187. </summary>
  188. <typeparam name="T">The type that the method checks for.</typeparam>
  189. <returns>True if the type is registered, false otherwise.</returns>
  190. </member>
  191. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.IsRegistered``1(System.String)">
  192. <summary>
  193. Gets a value indicating whether a given type T and a give key
  194. are already registered.
  195. </summary>
  196. <typeparam name="T">The type that the method checks for.</typeparam>
  197. <param name="key">The key that the method checks for.</param>
  198. <returns>True if the type and key are registered, false otherwise.</returns>
  199. </member>
  200. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``2">
  201. <summary>
  202. Registers a given type for a given interface.
  203. </summary>
  204. <typeparam name="TInterface">The interface for which instances will be resolved.</typeparam>
  205. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  206. </member>
  207. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``2(System.Boolean)">
  208. <summary>
  209. Registers a given type for a given interface with the possibility for immediate
  210. creation of the instance.
  211. </summary>
  212. <typeparam name="TInterface">The interface for which instances will be resolved.</typeparam>
  213. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  214. <param name="createInstanceImmediately">If true, forces the creation of the default
  215. instance of the provided class.</param>
  216. </member>
  217. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1">
  218. <summary>
  219. Registers a given type.
  220. </summary>
  221. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  222. </member>
  223. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1(System.Boolean)">
  224. <summary>
  225. Registers a given type with the possibility for immediate
  226. creation of the instance.
  227. </summary>
  228. <typeparam name="TClass">The type that must be used to create instances.</typeparam>
  229. <param name="createInstanceImmediately">If true, forces the creation of the default
  230. instance of the provided class.</param>
  231. </member>
  232. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1(System.Func{``0})">
  233. <summary>
  234. Registers a given instance for a given type.
  235. </summary>
  236. <typeparam name="TClass">The type that is being registered.</typeparam>
  237. <param name="factory">The factory method able to create the instance that
  238. must be returned when the given type is resolved.</param>
  239. </member>
  240. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1(System.Func{``0},System.Boolean)">
  241. <summary>
  242. Registers a given instance for a given type with the possibility for immediate
  243. creation of the instance.
  244. </summary>
  245. <typeparam name="TClass">The type that is being registered.</typeparam>
  246. <param name="factory">The factory method able to create the instance that
  247. must be returned when the given type is resolved.</param>
  248. <param name="createInstanceImmediately">If true, forces the creation of the default
  249. instance of the provided class.</param>
  250. </member>
  251. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1(System.Func{``0},System.String)">
  252. <summary>
  253. Registers a given instance for a given type and a given key.
  254. </summary>
  255. <typeparam name="TClass">The type that is being registered.</typeparam>
  256. <param name="factory">The factory method able to create the instance that
  257. must be returned when the given type is resolved.</param>
  258. <param name="key">The key for which the given instance is registered.</param>
  259. </member>
  260. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Register``1(System.Func{``0},System.String,System.Boolean)">
  261. <summary>
  262. Registers a given instance for a given type and a given key with the possibility for immediate
  263. creation of the instance.
  264. </summary>
  265. <typeparam name="TClass">The type that is being registered.</typeparam>
  266. <param name="factory">The factory method able to create the instance that
  267. must be returned when the given type is resolved.</param>
  268. <param name="key">The key for which the given instance is registered.</param>
  269. <param name="createInstanceImmediately">If true, forces the creation of the default
  270. instance of the provided class.</param>
  271. </member>
  272. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Reset">
  273. <summary>
  274. Resets the instance in its original states. This deletes all the
  275. registrations.
  276. </summary>
  277. </member>
  278. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Unregister``1">
  279. <summary>
  280. Unregisters a class from the cache and removes all the previously
  281. created instances.
  282. </summary>
  283. <typeparam name="TClass">The class that must be removed.</typeparam>
  284. </member>
  285. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Unregister``1(``0)">
  286. <summary>
  287. Removes the given instance from the cache. The class itself remains
  288. registered and can be used to create other instances.
  289. </summary>
  290. <typeparam name="TClass">The type of the instance to be removed.</typeparam>
  291. <param name="instance">The instance that must be removed.</param>
  292. </member>
  293. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.Unregister``1(System.String)">
  294. <summary>
  295. Removes the instance corresponding to the given key from the cache. The class itself remains
  296. registered and can be used to create other instances.
  297. </summary>
  298. <typeparam name="TClass">The type of the instance to be removed.</typeparam>
  299. <param name="key">The key corresponding to the instance that must be removed.</param>
  300. </member>
  301. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetAllCreatedInstances(System.Type)">
  302. <summary>
  303. Provides a way to get all the created instances of a given type available in the
  304. cache. Registering a class or a factory does not automatically
  305. create the corresponding instance! To create an instance, either register
  306. the class or the factory with createInstanceImmediately set to true,
  307. or call the GetInstance method before calling GetAllCreatedInstances.
  308. Alternatively, use the GetAllInstances method, which auto-creates default
  309. instances for all registered classes.
  310. </summary>
  311. <param name="serviceType">The class of which all instances
  312. must be returned.</param>
  313. <returns>All the already created instances of the given type.</returns>
  314. </member>
  315. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetAllCreatedInstances``1">
  316. <summary>
  317. Provides a way to get all the created instances of a given type available in the
  318. cache. Registering a class or a factory does not automatically
  319. create the corresponding instance! To create an instance, either register
  320. the class or the factory with createInstanceImmediately set to true,
  321. or call the GetInstance method before calling GetAllCreatedInstances.
  322. Alternatively, use the GetAllInstances method, which auto-creates default
  323. instances for all registered classes.
  324. </summary>
  325. <typeparam name="TService">The class of which all instances
  326. must be returned.</typeparam>
  327. <returns>All the already created instances of the given type.</returns>
  328. </member>
  329. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetService(System.Type)">
  330. <summary>
  331. Gets the service object of the specified type.
  332. </summary>
  333. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type serviceType has not
  334. been registered before calling this method.</exception>
  335. <returns>
  336. A service object of type <paramref name="serviceType"/>.
  337. </returns>
  338. <param name="serviceType">An object that specifies the type of service object to get.</param>
  339. </member>
  340. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetAllInstances(System.Type)">
  341. <summary>
  342. Provides a way to get all the created instances of a given type available in the
  343. cache. Calling this method auto-creates default
  344. instances for all registered classes.
  345. </summary>
  346. <param name="serviceType">The class of which all instances
  347. must be returned.</param>
  348. <returns>All the instances of the given type.</returns>
  349. </member>
  350. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetAllInstances``1">
  351. <summary>
  352. Provides a way to get all the created instances of a given type available in the
  353. cache. Calling this method auto-creates default
  354. instances for all registered classes.
  355. </summary>
  356. <typeparam name="TService">The class of which all instances
  357. must be returned.</typeparam>
  358. <returns>All the instances of the given type.</returns>
  359. </member>
  360. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstance(System.Type)">
  361. <summary>
  362. Provides a way to get an instance of a given type. If no instance had been instantiated
  363. before, a new instance will be created. If an instance had already
  364. been created, that same instance will be returned.
  365. </summary>
  366. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type serviceType has not
  367. been registered before calling this method.</exception>
  368. <param name="serviceType">The class of which an instance
  369. must be returned.</param>
  370. <returns>An instance of the given type.</returns>
  371. </member>
  372. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstanceWithoutCaching(System.Type)">
  373. <summary>
  374. Provides a way to get an instance of a given type. This method
  375. always returns a new instance and doesn't cache it in the IOC container.
  376. </summary>
  377. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type serviceType has not
  378. been registered before calling this method.</exception>
  379. <param name="serviceType">The class of which an instance
  380. must be returned.</param>
  381. <returns>An instance of the given type.</returns>
  382. </member>
  383. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstance(System.Type,System.String)">
  384. <summary>
  385. Provides a way to get an instance of a given type corresponding
  386. to a given key. If no instance had been instantiated with this
  387. key before, a new instance will be created. If an instance had already
  388. been created with the same key, that same instance will be returned.
  389. </summary>
  390. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type serviceType has not
  391. been registered before calling this method.</exception>
  392. <param name="serviceType">The class of which an instance must be returned.</param>
  393. <param name="key">The key uniquely identifying this instance.</param>
  394. <returns>An instance corresponding to the given type and key.</returns>
  395. </member>
  396. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstanceWithoutCaching(System.Type,System.String)">
  397. <summary>
  398. Provides a way to get an instance of a given type. This method
  399. always returns a new instance and doesn't cache it in the IOC container.
  400. </summary>
  401. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type serviceType has not
  402. been registered before calling this method.</exception>
  403. <param name="serviceType">The class of which an instance must be returned.</param>
  404. <param name="key">The key uniquely identifying this instance.</param>
  405. <returns>An instance corresponding to the given type and key.</returns>
  406. </member>
  407. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstance``1">
  408. <summary>
  409. Provides a way to get an instance of a given type. If no instance had been instantiated
  410. before, a new instance will be created. If an instance had already
  411. been created, that same instance will be returned.
  412. </summary>
  413. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type TService has not
  414. been registered before calling this method.</exception>
  415. <typeparam name="TService">The class of which an instance
  416. must be returned.</typeparam>
  417. <returns>An instance of the given type.</returns>
  418. </member>
  419. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstanceWithoutCaching``1">
  420. <summary>
  421. Provides a way to get an instance of a given type. This method
  422. always returns a new instance and doesn't cache it in the IOC container.
  423. </summary>
  424. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type TService has not
  425. been registered before calling this method.</exception>
  426. <typeparam name="TService">The class of which an instance
  427. must be returned.</typeparam>
  428. <returns>An instance of the given type.</returns>
  429. </member>
  430. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstance``1(System.String)">
  431. <summary>
  432. Provides a way to get an instance of a given type corresponding
  433. to a given key. If no instance had been instantiated with this
  434. key before, a new instance will be created. If an instance had already
  435. been created with the same key, that same instance will be returned.
  436. </summary>
  437. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type TService has not
  438. been registered before calling this method.</exception>
  439. <typeparam name="TService">The class of which an instance must be returned.</typeparam>
  440. <param name="key">The key uniquely identifying this instance.</param>
  441. <returns>An instance corresponding to the given type and key.</returns>
  442. </member>
  443. <member name="M:GalaSoft.MvvmLight.Ioc.SimpleIoc.GetInstanceWithoutCaching``1(System.String)">
  444. <summary>
  445. Provides a way to get an instance of a given type. This method
  446. always returns a new instance and doesn't cache it in the IOC container.
  447. </summary>
  448. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">If the type TService has not
  449. been registered before calling this method.</exception>
  450. <typeparam name="TService">The class of which an instance must be returned.</typeparam>
  451. <param name="key">The key uniquely identifying this instance.</param>
  452. <returns>An instance corresponding to the given type and key.</returns>
  453. </member>
  454. <member name="P:GalaSoft.MvvmLight.Ioc.SimpleIoc.Default">
  455. <summary>
  456. This class' default instance.
  457. </summary>
  458. </member>
  459. </members>
  460. </doc>