Tools/dotnetcli/sdk/NuGetFallbackFolder/microsoft.extensions.localization/2.0.1/lib/netstandard2.0/Microsoft.Extensions.Localization.xml

   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="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer">
 210             <summary>
 211             An <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> that uses the <see cref="T:System.Resources.ResourceManager"/> and
 212             <see cref="T:System.Resources.ResourceReader"/> to provide localized strings for a specific <see cref="T:System.Globalization.CultureInfo"/>.
 213             </summary>
 214         </member>
 215         <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)">
 216             <summary>
 217             Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer"/>.
 218             </summary>
 219             <param name="resourceManager">The <see cref="T:System.Resources.ResourceManager"/> to read strings from.</param>
 220             <param name="resourceStringProvider">The <see cref="T:Microsoft.Extensions.Localization.Internal.IResourceStringProvider"/> that can find the resources.</param>
 221             <param name="baseName">The base name of the embedded resource that contains the strings.</param>
 222             <param name="resourceNamesCache">Cache of the list of strings for a given resource assembly name.</param>
 223             <param name="culture">The specific <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
 224             <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
 225         </member>
 226         <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)">
 227             <summary>
 228             Creates a new <see cref="T:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer"/>.
 229             </summary>
 230             <param name="resourceManager">The <see cref="T:System.Resources.ResourceManager"/> to read strings from.</param>
 231             <param name="resourceAssembly">The <see cref="T:System.Reflection.Assembly"/> that contains the strings as embedded resources.</param>
 232             <param name="baseName">The base name of the embedded resource that contains the strings.</param>
 233             <param name="resourceNamesCache">Cache of the list of strings for a given resource assembly name.</param>
 234             <param name="culture">The specific <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
 235             <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
 236         </member>
 237         <member name="P:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.Item(System.String)">
 238             <inheritdoc />
 239         </member>
 240         <member name="P:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.Item(System.String,System.Object[])">
 241             <inheritdoc />
 242         </member>
 243         <member name="M:Microsoft.Extensions.Localization.ResourceManagerWithCultureStringLocalizer.GetAllStrings(System.Boolean)">
 244             <inheritdoc />
 245         </member>
 246         <member name="T:Microsoft.Extensions.Localization.ResourceNamesCache">
 247             <summary>
 248             An implementation of <see cref="T:Microsoft.Extensions.Localization.IResourceNamesCache"/> backed by a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2"/>.
 249             </summary>
 250         </member>
 251         <member name="M:Microsoft.Extensions.Localization.ResourceNamesCache.GetOrAdd(System.String,System.Func{System.String,System.Collections.Generic.IList{System.String}})">
 252             <inheritdoc />
 253         </member>
 254         <member name="T:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions">
 255             <summary>
 256             Extension methods for setting up localization services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
 257             </summary>
 258         </member>
 259         <member name="M:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions.AddLocalization(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
 260             <summary>
 261             Adds services required for application localization.
 262             </summary>
 263             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
 264             <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
 265         </member>
 266         <member name="M:Microsoft.Extensions.DependencyInjection.LocalizationServiceCollectionExtensions.AddLocalization(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Localization.LocalizationOptions})">
 267             <summary>
 268             Adds services required for application localization.
 269             </summary>
 270             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
 271             <param name="setupAction">
 272             An <see cref="T:System.Action`1"/> to configure the <see cref="T:Microsoft.Extensions.Localization.LocalizationOptions"/>.
 273             </param>
 274             <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
 275         </member>
 276     </members>
 277 </doc>