You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Microsoft.Practices.Unity.RegistrationByConvention.XML 18 KiB

4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Practices.Unity.RegistrationByConvention</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Practices.Unity.AllClasses">
  8. <summary>
  9. Provides helper methods to retrieve classes from assemblies.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Practices.Unity.AllClasses.FromAssemblies(System.Reflection.Assembly[])">
  13. <summary>
  14. Returns all visible, non-abstract classes from <paramref name="assemblies"/>.
  15. </summary>
  16. <param name="assemblies">The assemblies.</param>
  17. <returns>All visible, non-abstract classes found in the assemblies.</returns>
  18. <exception cref="T:System.ArgumentNullException"><paramref name="assemblies"/> is <see langword="null"/>.</exception>
  19. <exception cref="T:System.ArgumentException"><paramref name="assemblies"/> contains <see langword="null"/> elements.</exception>
  20. <remarks>All exceptions thrown while getting types from the assemblies are ignored, and the types that can be retrieved are returned.</remarks>
  21. </member>
  22. <member name="M:Microsoft.Practices.Unity.AllClasses.FromAssemblies(System.Boolean,System.Reflection.Assembly[])">
  23. <summary>
  24. Returns all visible, non-abstract classes from <paramref name="assemblies"/>, and optionally skips errors.
  25. </summary>
  26. <param name="skipOnError"><see langword="true"/> to skip errors; otherwise, <see langword="true"/>.</param>
  27. <param name="assemblies">The assemblies.</param>
  28. <returns>
  29. All visible, non-abstract classes.
  30. </returns>
  31. <exception cref="T:System.ArgumentNullException"><paramref name="assemblies"/> is <see langword="null"/>.</exception>
  32. <exception cref="T:System.ArgumentException"><paramref name="assemblies"/> contains <see langword="null"/> elements.</exception>
  33. <remarks>
  34. If <paramref name="skipOnError"/> is <see langword="true"/>, all exceptions thrown while getting types from the assemblies are ignored, and the types
  35. that can be retrieved are returned; otherwise, the original exception is thrown.
  36. </remarks>
  37. </member>
  38. <member name="M:Microsoft.Practices.Unity.AllClasses.FromAssemblies(System.Collections.Generic.IEnumerable{System.Reflection.Assembly},System.Boolean)">
  39. <summary>
  40. Returns all visible, non-abstract classes from <paramref name="assemblies"/>.
  41. </summary>
  42. <param name="skipOnError"><see langword="true"/> to skip errors; otherwise, <see langword="true"/>.</param>
  43. <param name="assemblies">The assemblies.</param>
  44. <returns>
  45. All visible, non-abstract classes.
  46. </returns>
  47. <exception cref="T:System.ArgumentNullException"><paramref name="assemblies"/> is <see langword="null"/>.</exception>
  48. <exception cref="T:System.ArgumentException"><paramref name="assemblies"/> contains <see langword="null"/> elements.</exception>
  49. <remarks>
  50. If <paramref name="skipOnError"/> is <see langword="true"/>, all exceptions thrown while getting types from the assemblies are ignored, and the types
  51. that can be retrieved are returned; otherwise, the original exception is thrown.
  52. </remarks>
  53. </member>
  54. <member name="M:Microsoft.Practices.Unity.AllClasses.FromApplication(System.Boolean,System.Boolean)">
  55. <summary>
  56. Returns all visible, non-abstract classes from all assemblies located where the application is installed.
  57. </summary>
  58. <param name="includeUnityAssemblies"><see langword="false"/> to include the Unity assemblies; otherwise, <see langword="false"/>. Defaults to <see langword="false"/>.</param>
  59. <param name="skipOnError"><see langword="true"/> to skip errors; otherwise, <see langword="true"/>.</param>
  60. <returns>
  61. All visible, non-abstract classes.
  62. </returns>
  63. <remarks>
  64. If <paramref name="skipOnError"/> is <see langword="true"/>, all exceptions thrown while loading assemblies or getting types from the assemblies
  65. are ignored, and the types that can be retrieved are returned; otherwise, the original exception is thrown. These exceptions might be wrapped in a
  66. <see cref="T:System.AggregateException"/>.
  67. </remarks>
  68. </member>
  69. <member name="T:Microsoft.Practices.Unity.DuplicateTypeMappingException">
  70. <summary>
  71. The exception that is thrown when registering multiple types would result in an type mapping being overwritten.
  72. </summary>
  73. </member>
  74. <member name="M:Microsoft.Practices.Unity.DuplicateTypeMappingException.#ctor(System.String,System.Type,System.Type,System.Type)">
  75. <summary>
  76. Initializes a new instance of the <see cref="T:Microsoft.Practices.Unity.DuplicateTypeMappingException"/> class.
  77. </summary>
  78. <param name="name">The name for the mapping.</param>
  79. <param name="mappedFromType">The source type for the mapping.</param>
  80. <param name="currentMappedToType">The type currently mapped.</param>
  81. <param name="newMappedToType">The new type to map.</param>
  82. </member>
  83. <member name="P:Microsoft.Practices.Unity.DuplicateTypeMappingException.Name">
  84. <summary>
  85. Gets the name for the mapping.
  86. </summary>
  87. </member>
  88. <member name="P:Microsoft.Practices.Unity.DuplicateTypeMappingException.MappedFromType">
  89. <summary>
  90. Gets the source type for the mapping.
  91. </summary>
  92. </member>
  93. <member name="P:Microsoft.Practices.Unity.DuplicateTypeMappingException.CurrentMappedToType">
  94. <summary>
  95. Gets the type currently mapped.
  96. </summary>
  97. </member>
  98. <member name="P:Microsoft.Practices.Unity.DuplicateTypeMappingException.NewMappedToType">
  99. <summary>
  100. Gets the new type to map.
  101. </summary>
  102. </member>
  103. <member name="T:Microsoft.Practices.Unity.RegistrationConvention">
  104. <summary>
  105. Represents a set of types to register and their registration settings.
  106. </summary>
  107. </member>
  108. <member name="M:Microsoft.Practices.Unity.RegistrationConvention.GetTypes">
  109. <summary>
  110. Gets types to register.
  111. </summary>
  112. </member>
  113. <member name="M:Microsoft.Practices.Unity.RegistrationConvention.GetFromTypes">
  114. <summary>
  115. Gets a function to get the types that will be requested for each type to configure.
  116. </summary>
  117. </member>
  118. <member name="M:Microsoft.Practices.Unity.RegistrationConvention.GetName">
  119. <summary>
  120. Gets a function to get the name to use for the registration of each type.
  121. </summary>
  122. </member>
  123. <member name="M:Microsoft.Practices.Unity.RegistrationConvention.GetLifetimeManager">
  124. <summary>
  125. Gets a function to get the <see cref="T:Microsoft.Practices.Unity.LifetimeManager"/> for the registration of each type. Defaults to no lifetime management.
  126. </summary>
  127. <returns></returns>
  128. </member>
  129. <member name="M:Microsoft.Practices.Unity.RegistrationConvention.GetInjectionMembers">
  130. <summary>
  131. Gets a function to get the additional <see cref="T:Microsoft.Practices.Unity.InjectionMember"/> objects for the registration of each type. Defaults to no injection members.
  132. </summary>
  133. <returns></returns>
  134. </member>
  135. <member name="T:Microsoft.Practices.Unity.Resources">
  136. <summary>
  137. A strongly-typed resource class, for looking up localized strings, etc.
  138. </summary>
  139. </member>
  140. <member name="P:Microsoft.Practices.Unity.Resources.ResourceManager">
  141. <summary>
  142. Returns the cached ResourceManager instance used by this class.
  143. </summary>
  144. </member>
  145. <member name="P:Microsoft.Practices.Unity.Resources.DuplicateTypeMappingException">
  146. <summary>
  147. An attempt to override an existing mapping was detected for type {1} wit...
  148. </summary>
  149. </member>
  150. <member name="P:Microsoft.Practices.Unity.Resources.ExceptionNullAssembly">
  151. <summary>
  152. The set of assemblies contains a null element.
  153. </summary>
  154. </member>
  155. <member name="T:Microsoft.Practices.Unity.UnityContainerRegistrationByConventionExtensions">
  156. <summary>
  157. Provides a set of convenience overloads to the
  158. <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> interface to support registration of multiple types.
  159. </summary>
  160. </member>
  161. <member name="M:Microsoft.Practices.Unity.UnityContainerRegistrationByConventionExtensions.RegisterTypes(Microsoft.Practices.Unity.IUnityContainer,System.Collections.Generic.IEnumerable{System.Type},System.Func{System.Type,System.Collections.Generic.IEnumerable{System.Type}},System.Func{System.Type,System.String},System.Func{System.Type,Microsoft.Practices.Unity.LifetimeManager},System.Func{System.Type,System.Collections.Generic.IEnumerable{Microsoft.Practices.Unity.InjectionMember}},System.Boolean)">
  162. <summary>
  163. Registers the supplied types by using the specified rules for name, lifetime manager, injection members, and registration types.
  164. </summary>
  165. <param name="container">The container to configure.</param>
  166. <param name="types">The types to register. The methods in the <see cref="T:Microsoft.Practices.Unity.AllClasses"/> class can be used to scan assemblies to get types, and further filtering can be performed using LINQ queries.</param>
  167. <param name="getFromTypes">A function that gets the types that will be requested for each type to configure. It can be a method from the <see cref="T:Microsoft.Practices.Unity.WithMappings"/> class or a custom function. Defaults to no registration types, and registers only the supplied types.</param>
  168. <param name="getName">A function that gets the name to use for the registration of each type. It can be a method from the <see cref="T:Microsoft.Practices.Unity.WithName"/> or a custom function. Defaults to no name.</param>
  169. <param name="getLifetimeManager">A function that gets the <see cref="T:Microsoft.Practices.Unity.LifetimeManager"/> for the registration of each type. It can be a method from the <see cref="T:Microsoft.Practices.Unity.WithLifetime"/> class or a custom function. Defaults to no lifetime management.</param>
  170. <param name="getInjectionMembers">A function that gets the additional <see cref="T:Microsoft.Practices.Unity.InjectionMember"/> objects for the registration of each type. Defaults to no injection members.</param>
  171. <param name="overwriteExistingMappings"><see langword="true"/> to overwrite existing mappings; otherwise, <see langword="false"/>. Defaults to <see langword="false"/>.</param>
  172. <returns>
  173. The container that this method was called on.
  174. </returns>
  175. <exception cref="T:System.ArgumentException">A new registration would overwrite an existing mapping and <paramref name="overwriteExistingMappings"/> is <see langword="false"/>.</exception>
  176. </member>
  177. <member name="M:Microsoft.Practices.Unity.UnityContainerRegistrationByConventionExtensions.RegisterTypes(Microsoft.Practices.Unity.IUnityContainer,Microsoft.Practices.Unity.RegistrationConvention,System.Boolean)">
  178. <summary>
  179. Registers the types according to the <paramref name="convention"/>.
  180. </summary>
  181. <param name="container">The container to configure.</param>
  182. <param name="convention">The convention to determine which types will be registered and how.</param>
  183. <param name="overwriteExistingMappings"><see langword="true"/> to overwrite existing mappings; otherwise, <see langword="false"/>. Defaults to <see langword="false"/>.</param>
  184. <returns>
  185. The container that this method was called on.
  186. </returns>
  187. </member>
  188. <member name="T:Microsoft.Practices.Unity.WithLifetime">
  189. <summary>
  190. Provides helper methods to specify the lifetime for a type with registration by convention.
  191. </summary>
  192. </member>
  193. <member name="M:Microsoft.Practices.Unity.WithLifetime.None(System.Type)">
  194. <summary>
  195. Returns a <see langword="null"/> <see cref="T:Microsoft.Practices.Unity.LifetimeManager"/>.
  196. </summary>
  197. <param name="type">The type.</param>
  198. <returns>A lifetime manager</returns>
  199. </member>
  200. <member name="M:Microsoft.Practices.Unity.WithLifetime.ContainerControlled(System.Type)">
  201. <summary>
  202. Returns a <see cref="T:Microsoft.Practices.Unity.ContainerControlledLifetimeManager"/>.
  203. </summary>
  204. <param name="type">The type.</param>
  205. <returns>A container controlled lifetime manager.</returns>
  206. </member>
  207. <member name="M:Microsoft.Practices.Unity.WithLifetime.ExternallyControlled(System.Type)">
  208. <summary>
  209. Returns a <see cref="T:Microsoft.Practices.Unity.ExternallyControlledLifetimeManager"/>.
  210. </summary>
  211. <param name="type">The type.</param>
  212. <returns>An externally controlled lifetime manager.</returns>
  213. </member>
  214. <member name="M:Microsoft.Practices.Unity.WithLifetime.Hierarchical(System.Type)">
  215. <summary>
  216. Returns a <see cref="T:Microsoft.Practices.Unity.HierarchicalLifetimeManager"/>.
  217. </summary>
  218. <param name="type">The type.</param>
  219. <returns>A hierarchical lifetime manager.</returns>
  220. </member>
  221. <member name="M:Microsoft.Practices.Unity.WithLifetime.PerResolve(System.Type)">
  222. <summary>
  223. Returns a <see cref="T:Microsoft.Practices.Unity.PerResolveLifetimeManager"/>.
  224. </summary>
  225. <param name="type">The type.</param>
  226. <returns>A per resolve lifetime manager.</returns>
  227. </member>
  228. <member name="M:Microsoft.Practices.Unity.WithLifetime.Transient(System.Type)">
  229. <summary>
  230. Returns a <see cref="T:Microsoft.Practices.Unity.TransientLifetimeManager"/>.
  231. </summary>
  232. <param name="type">The type.</param>
  233. <returns>A transient lifetime manager.</returns>
  234. </member>
  235. <member name="M:Microsoft.Practices.Unity.WithLifetime.Custom``1(System.Type)">
  236. <summary>
  237. Returns a <see cref="T:Microsoft.Practices.Unity.LifetimeManager"/>.
  238. </summary>
  239. <typeparam name="T">The custom <see cref="T:Microsoft.Practices.Unity.LifetimeManager"/> type.</typeparam>
  240. <param name="type">The type.</param>
  241. <returns>
  242. A lifetime manager.
  243. </returns>
  244. </member>
  245. <member name="M:Microsoft.Practices.Unity.WithLifetime.PerThread(System.Type)">
  246. <summary>
  247. Returns a <see cref="T:Microsoft.Practices.Unity.PerThreadLifetimeManager"/>.
  248. </summary>
  249. <param name="type">The type.</param>
  250. <returns>A per thread lifetime manager.</returns>
  251. </member>
  252. <member name="T:Microsoft.Practices.Unity.WithMappings">
  253. <summary>
  254. Provides helper methods to map types to the types interfaces to which register them.
  255. </summary>
  256. </member>
  257. <member name="M:Microsoft.Practices.Unity.WithMappings.None(System.Type)">
  258. <summary>
  259. Returns no types.
  260. </summary>
  261. <param name="implementationType">The type to register.</param>
  262. <returns>An empty enumeration.</returns>
  263. </member>
  264. <member name="M:Microsoft.Practices.Unity.WithMappings.FromMatchingInterface(System.Type)">
  265. <summary>
  266. Returns an enumeration with the interface that matches the name of <paramref name="implementationType"/>.
  267. </summary>
  268. <param name="implementationType">The type to register.</param>
  269. <returns>An enumeration with the first interface matching the name of <paramref name="implementationType"/> (for example, if type is MyType, a matching interface is IMyType),
  270. or an empty enumeration if no such interface is found.</returns>
  271. </member>
  272. <member name="M:Microsoft.Practices.Unity.WithMappings.FromAllInterfaces(System.Type)">
  273. <summary>
  274. Returns an enumeration with all the interfaces implemented by <paramref name="implementationType"/>.
  275. </summary>
  276. <param name="implementationType">The type to register.</param>
  277. <returns>An enumeration with all the interfaces implemented by the implementation type except <see cref="T:System.IDisposable"/>.</returns>
  278. </member>
  279. <member name="M:Microsoft.Practices.Unity.WithMappings.FromAllInterfacesInSameAssembly(System.Type)">
  280. <summary>
  281. Returns an enumeration with all the interfaces implemented by <paramref name="implementationType"/> that belong to the same assembly as implementationType.
  282. </summary>
  283. <param name="implementationType">The type to register.</param>
  284. <returns>An enumeration with all the interfaces implemented by the implementation type that belong to the same assembly.</returns>
  285. </member>
  286. <member name="T:Microsoft.Practices.Unity.WithName">
  287. <summary>
  288. Provides helper methods to get type names.
  289. </summary>
  290. </member>
  291. <member name="M:Microsoft.Practices.Unity.WithName.TypeName(System.Type)">
  292. <summary>
  293. Returns the type name.
  294. </summary>
  295. <param name="type">The type.</param>
  296. <returns>The type name.</returns>
  297. </member>
  298. <member name="M:Microsoft.Practices.Unity.WithName.Default(System.Type)">
  299. <summary>
  300. Returns null for the registration name.
  301. </summary>
  302. <param name="type">The type.</param>
  303. <returns><see langword="null"/></returns>
  304. </member>
  305. </members>
  306. </doc>