Microsoft.Extensions.Localization.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Localization</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Localization.IResourceNamesCache">
  8. <summary>
  9. Represents a cache of string names in resources.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Localization.IResourceNamesCache.GetOrAdd(System.String,System.Func{System.String,System.Collections.Generic.IList{System.String}})">
  13. <summary>
  14. Adds a set of resource names to the cache by using the specified function, if the name does not already exist.
  15. </summary>
  16. <param name="name">The resource name to add string names for.</param>
  17. <param name="valueFactory">The function used to generate the string names for the resource.</param>
  18. <returns>The string names for the resource.</returns>
  19. </member>
  20. <member name="T:Microsoft.Extensions.Localization.LocalizationOptions">
  21. <summary>
  22. Provides programmatic configuration for localization.
  23. </summary>
  24. </member>
  25. <member name="P:Microsoft.Extensions.Localization.LocalizationOptions.ResourcesPath">
  26. <summary>
  27. The relative path under application root where resource files are located.
  28. </summary>
  29. </member>
  30. <member name="P:Microsoft.Extensions.Localization.Resources.Localization_MissingManifest">
  31. <summary>
  32. The manifest '{0}' was not found.
  33. </summary>
  34. </member>
  35. <member name="M:Microsoft.Extensions.Localization.Resources.FormatLocalization_MissingManifest(System.Object)">
  36. <summary>
  37. The manifest '{0}' was not found.
  38. </summary>
  39. </member>
  40. <member name="P:Microsoft.Extensions.Localization.Resources.Localization_MissingManifest_Parent">
  41. <summary>
  42. No manifests exist for the current culture.
  43. </summary>
  44. </member>
  45. <member name="M:Microsoft.Extensions.Localization.Resources.FormatLocalization_MissingManifest_Parent">
  46. <summary>
  47. No manifests exist for the current culture.
  48. </summary>
  49. </member>
  50. <member name="T:Microsoft.Extensions.Localization.ResourceLocationAttribute">
  51. <summary>
  52. Provides the location of resources for an Assembly.
  53. </summary>
  54. </member>
  55. <member name="M:Microsoft.Extensions.Localization.ResourceLocationAttribute.#ctor(System.String)">
  56. <summary>
  57. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceLocationAttribute"/>.
  58. </summary>
  59. <param name="resourceLocation">The location of resources for this Assembly.</param>
  60. </member>
  61. <member name="P:Microsoft.Extensions.Localization.ResourceLocationAttribute.ResourceLocation">
  62. <summary>
  63. The location of resources for this Assembly.
  64. </summary>
  65. </member>
  66. <member name="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer">
  67. <summary>
  68. An <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> that uses the <see cref="T:System.Resources.ResourceManager"/> and
  69. <see cref="T:System.Resources.ResourceReader"/> to provide localized strings.
  70. </summary>
  71. <remarks>This type is thread-safe.</remarks>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.#ctor(System.Resources.ResourceManager,System.Reflection.Assembly,System.String,Microsoft.Extensions.Localization.IResourceNamesCache,Microsoft.Extensions.Logging.ILogger)">
  74. <summary>
  75. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.
  76. </summary>
  77. <param name="resourceManager">The <see cref="T:System.Resources.ResourceManager"/> to read strings from.</param>
  78. <param name="resourceAssembly">The <see cref="T:System.Reflection.Assembly"/> that contains the strings as embedded resources.</param>
  79. <param name="baseName">The base name of the embedded resource that contains the strings.</param>
  80. <param name="resourceNamesCache">Cache of the list of strings for a given resource assembly name.</param>
  81. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
  82. </member>
  83. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.#ctor(System.Resources.ResourceManager,Microsoft.Extensions.Localization.Internal.AssemblyWrapper,System.String,Microsoft.Extensions.Localization.IResourceNamesCache,Microsoft.Extensions.Logging.ILogger)">
  84. <summary>
  85. Intended for testing purposes only.
  86. </summary>
  87. </member>
  88. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.#ctor(System.Resources.ResourceManager,Microsoft.Extensions.Localization.Internal.IResourceStringProvider,System.String,Microsoft.Extensions.Localization.IResourceNamesCache,Microsoft.Extensions.Logging.ILogger)">
  89. <summary>
  90. Intended for testing purposes only.
  91. </summary>
  92. </member>
  93. <member name="P:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.Item(System.String)">
  94. <inheritdoc />
  95. </member>
  96. <member name="P:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.Item(System.String,System.Object[])">
  97. <inheritdoc />
  98. </member>
  99. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.WithCulture(System.Globalization.CultureInfo)">
  100. <summary>
  101. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/> for a specific <see cref="T:System.Globalization.CultureInfo"/>.
  102. </summary>
  103. <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
  104. <returns>A culture-specific <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.</returns>
  105. </member>
  106. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.GetAllStrings(System.Boolean)">
  107. <inheritdoc />
  108. </member>
  109. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.GetAllStrings(System.Boolean,System.Globalization.CultureInfo)">
  110. <summary>
  111. Returns all strings in the specified culture.
  112. </summary>
  113. <param name="includeParentCultures"></param>
  114. <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> to get strings for.</param>
  115. <returns>The strings.</returns>
  116. </member>
  117. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer.GetStringSafely(System.String,System.Globalization.CultureInfo)">
  118. <summary>
  119. Gets a resource string from the <see cref="F:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer._resourceManager"/> and returns <c>null</c> instead of
  120. throwing exceptions if a match isn't found.
  121. </summary>
  122. <param name="name">The name of the string resource.</param>
  123. <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> to get the string for.</param>
  124. <returns>The resource string, or <c>null</c> if none was found.</returns>
  125. </member>
  126. <member name="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory">
  127. <summary>
  128. An <see cref="T:Microsoft.Extensions.Localization.IStringLocalizerFactory"/> that creates instances of <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.
  129. </summary>
  130. <remarks>
  131. <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory"/> offers multiple ways to set the relative path of
  132. resources to be used. They are, in order of precedence:
  133. <see cref="T:Microsoft.Extensions.Localization.ResourceLocationAttribute"/> -> <see cref="P:Microsoft.Extensions.Localization.LocalizationOptions.ResourcesPath"/> -> the project root.
  134. </remarks>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Localization.LocalizationOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
  137. <summary>
  138. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.
  139. </summary>
  140. <param name="localizationOptions">The <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.</param>
  141. <param name="loggerFactory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.</param>
  142. </member>
  143. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetResourcePrefix(System.Reflection.TypeInfo)">
  144. <summary>
  145. Gets the resource prefix used to look up the resource.
  146. </summary>
  147. <param name="typeInfo">The type of the resource to be looked up.</param>
  148. <returns>The prefix for resource lookup.</returns>
  149. </member>
  150. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetResourcePrefix(System.Reflection.TypeInfo,System.String,System.String)">
  151. <summary>
  152. Gets the resource prefix used to look up the resource.
  153. </summary>
  154. <param name="typeInfo">The type of the resource to be looked up.</param>
  155. <param name="baseNamespace">The base namespace of the application.</param>
  156. <param name="resourcesRelativePath">The folder containing all resources.</param>
  157. <returns>The prefix for resource lookup.</returns>
  158. <remarks>
  159. For the type "Sample.Controllers.Home" if there's a resourceRelativePath return
  160. "Sample.Resourcepath.Controllers.Home" if there isn't one then it would return "Sample.Controllers.Home".
  161. </remarks>
  162. </member>
  163. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetResourcePrefix(System.String,System.String)">
  164. <summary>
  165. Gets the resource prefix used to look up the resource.
  166. </summary>
  167. <param name="baseResourceName">The name of the resource to be looked up</param>
  168. <param name="baseNamespace">The base namespace of the application.</param>
  169. <returns>The prefix for resource lookup.</returns>
  170. </member>
  171. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.Create(System.Type)">
  172. <summary>
  173. Creates a <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/> using the <see cref="T:System.Reflection.Assembly"/> and
  174. <see cref="P:System.Type.FullName"/> of the specified <see cref="T:System.Type"/>.
  175. </summary>
  176. <param name="resourceSource">The <see cref="T:System.Type"/>.</param>
  177. <returns>The <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.</returns>
  178. </member>
  179. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.Create(System.String,System.String)">
  180. <summary>
  181. Creates a <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.
  182. </summary>
  183. <param name="baseName">The base name of the resource to load strings from.</param>
  184. <param name="location">The location to load resources from.</param>
  185. <returns>The <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/>.</returns>
  186. </member>
  187. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.CreateResourceManagerStringLocalizer(System.Reflection.Assembly,System.String)">
  188. <summary>Creates a <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/> for the given input.</summary>
  189. <param name="assembly">The assembly to create a <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/> for.</param>
  190. <param name="baseName">The base name of the resource to search for.</param>
  191. <returns>A <see cref="T:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer"/> for the given <paramref name="assembly"/> and <paramref name="baseName"/>.</returns>
  192. <remarks>This method is virtual for testing purposes only.</remarks>
  193. </member>
  194. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetResourcePrefix(System.String,System.String,System.String)">
  195. <summary>
  196. Gets the resource prefix used to look up the resource.
  197. </summary>
  198. <param name="location">The general location of the resource.</param>
  199. <param name="baseName">The base name of the resource.</param>
  200. <param name="resourceLocation">The location of the resource within <paramref name="location"/>.</param>
  201. <returns>The resource prefix used to look up the resource.</returns>
  202. </member>
  203. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetResourceLocationAttribute(System.Reflection.Assembly)">
  204. <summary>Gets a <see cref="T:Microsoft.Extensions.Localization.ResourceLocationAttribute"/> from the provided <see cref="T:System.Reflection.Assembly"/>.</summary>
  205. <param name="assembly">The assembly to get a <see cref="T:Microsoft.Extensions.Localization.ResourceLocationAttribute"/> from.</param>
  206. <returns>The <see cref="T:Microsoft.Extensions.Localization.ResourceLocationAttribute"/> associated with the given <see cref="T:System.Reflection.Assembly"/>.</returns>
  207. <remarks>This method is protected and virtual for testing purposes only.</remarks>
  208. </member>
  209. <member name="M:Microsoft.Extensions.Localization.ResourceManagerStringLocalizerFactory.GetRootNamespaceAttribute(System.Reflection.Assembly)">
  210. <summary>Gets a <see cref="T:Microsoft.Extensions.Localization.RootNamespaceAttribute"/> from the provided <see cref="T:System.Reflection.Assembly"/>.</summary>
  211. <param name="assembly">The assembly to get a <see cref="T:Microsoft.Extensions.Localization.RootNamespaceAttribute"/> from.</param>
  212. <returns>The <see cref="T:Microsoft.Extensions.Localization.RootNamespaceAttribute"/> associated with the given <see cref="T:System.Reflection.Assembly"/>.</returns>
  213. <remarks>This method is protected and virtual for testing purposes only.</remarks>
  214. </member>
  215. <member name="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer">
  216. <summary>
  217. An <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> that uses the <see cref="T:System.Resources.ResourceManager"/> and
  218. <see cref="T:System.Resources.ResourceReader"/> to provide localized strings for a specific <see cref="T:System.Globalization.CultureInfo"/>.
  219. </summary>
  220. </member>
  221. <member name="M:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.#ctor(System.Resources.ResourceManager,Microsoft.Extensions.Localization.Internal.IResourceStringProvider,System.String,Microsoft.Extensions.Localization.IResourceNamesCache,System.Globalization.CultureInfo,Microsoft.Extensions.Logging.ILogger)">
  222. <summary>
  223. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer"/>.
  224. </summary>
  225. <param name="resourceManager">The <see cref="T:System.Resources.ResourceManager"/> to read strings from.</param>
  226. <param name="resourceStringProvider">The <see cref="T:Microsoft.Extensions.Localization.Internal.IResourceStringProvider"/> that can find the resources.</param>
  227. <param name="baseName">The base name of the embedded resource that contains the strings.</param>
  228. <param name="resourceNamesCache">Cache of the list of strings for a given resource assembly name.</param>
  229. <param name="culture">The specific <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
  230. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
  231. </member>
  232. <member name="M:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.#ctor(System.Resources.ResourceManager,System.Reflection.Assembly,System.String,Microsoft.Extensions.Localization.IResourceNamesCache,System.Globalization.CultureInfo,Microsoft.Extensions.Logging.ILogger)">
  233. <summary>
  234. Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer"/>.
  235. </summary>
  236. <param name="resourceManager">The <see cref="T:System.Resources.ResourceManager"/> to read strings from.</param>
  237. <param name="resourceAssembly">The <see cref="T:System.Reflection.Assembly"/> that contains the strings as embedded resources.</param>
  238. <param name="baseName">The base name of the embedded resource that contains the strings.</param>
  239. <param name="resourceNamesCache">Cache of the list of strings for a given resource assembly name.</param>
  240. <param name="culture">The specific <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
  241. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
  242. </member>
  243. <member name="P:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.Item(System.String)">
  244. <inheritdoc />
  245. </member>
  246. <member name="P:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.Item(System.String,System.Object[])">
  247. <inheritdoc />
  248. </member>
  249. <member name="M:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.GetAllStrings(System.Boolean)">
  250. <inheritdoc />
  251. </member>
  252. <member name="T:Microsoft.Extensions.Localization.ResourceNamesCache">
  253. <summary>
  254. An implementation of <see cref="T:Microsoft.Extensions.Localization.IResourceNamesCache"/> backed by a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2"/>.
  255. </summary>
  256. </member>
  257. <member name="M:Microsoft.Extensions.Localization.ResourceNamesCache.GetOrAdd(System.String,System.Func{System.String,System.Collections.Generic.IList{System.String}})">
  258. <inheritdoc />
  259. </member>
  260. <member name="T:Microsoft.Extensions.Localization.RootNamespaceAttribute">
  261. <summary>
  262. Provides the RootNamespace of an Assembly. The RootNamespace of the assembly is used by Localization to
  263. determine the resource name to look for when RootNamespace differs from the AssemblyName.
  264. </summary>
  265. </member>
  266. <member name="M:Microsoft.Extensions.Localization.RootNamespaceAttribute.#ctor(System.String)">
  267. <summary>
  268. Creates a new <see cref="T:Microsoft.Extensions.Localization.RootNamespaceAttribute"/>.
  269. </summary>
  270. <param name="rootNamespace">The RootNamespace for this Assembly.</param>
  271. </member>
  272. <member name="P:Microsoft.Extensions.Localization.RootNamespaceAttribute.RootNamespace">
  273. <summary>
  274. The RootNamespace of this Assembly. The RootNamespace of the assembly is used by Localization to
  275. determine the resource name to look for when RootNamespace differs from the AssemblyName.
  276. </summary>
  277. </member>
  278. <member name="T:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions">
  279. <summary>
  280. Extension methods for setting up localization services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  281. </summary>
  282. </member>
  283. <member name="M:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions.AddLocalization(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  284. <summary>
  285. Adds services required for application localization.
  286. </summary>
  287. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  288. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  289. </member>
  290. <member name="M:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions.AddLocalization(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Localization.LocalizationOptions})">
  291. <summary>
  292. Adds services required for application localization.
  293. </summary>
  294. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  295. <param name="setupAction">
  296. An <see cref="T:System.Action`1"/> to configure the <see cref="T:Microsoft.Extensions.Localization.LocalizationOptions"/>.
  297. </param>
  298. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  299. </member>
  300. </members>
  301. </doc>