4 <name>Microsoft.AspNetCore.Localization</name>
7 <member name="T:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider">
9 Determines the culture information for a request via the value of the Accept-Language header.
12 <member name="P:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider.MaximumAcceptLanguageHeaderValuesToTry">
14 The maximum number of values in the Accept-Language header to attempt to create a <see cref="T:System.Globalization.CultureInfo"/>
15 from for the current request.
19 <member name="M:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
22 <member name="T:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider">
24 Determines the culture information for a request via the value of a cookie.
27 <member name="F:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DefaultCookieName">
29 Represent the default cookie name used to track the user's preferred culture information, which is ".AspNetCore.Culture".
32 <member name="P:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.CookieName">
34 The name of the cookie that contains the user's preferred culture information.
35 Defaults to <see cref="F:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DefaultCookieName"/>.
38 <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
41 <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.MakeCookieValue(Microsoft.AspNetCore.Localization.RequestCulture)">
43 Creates a string representation of a <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> for placement in a cookie.
45 <param name="requestCulture">The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.</param>
46 <returns>The cookie value.</returns>
48 <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.ParseCookieValue(System.String)">
50 Parses a <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> from the specified cookie value.
51 Returns <c>null</c> if parsing fails.
53 <param name="value">The cookie value to parse.</param>
54 <returns>The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> or <c>null</c> if parsing fails.</returns>
56 <member name="T:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider">
58 Determines the culture information for a request via the configured delegate.
61 <member name="M:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider.#ctor(System.Func{Microsoft.AspNetCore.Http.HttpContext,System.Threading.Tasks.Task{Microsoft.AspNetCore.Localization.ProviderCultureResult}})">
63 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider"/> using the specified delegate.
65 <param name="provider">The provider delegate.</param>
67 <member name="M:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
70 <member name="T:Microsoft.AspNetCore.Localization.IRequestCultureFeature">
72 Represents the feature that provides the current request's culture information.
75 <member name="P:Microsoft.AspNetCore.Localization.IRequestCultureFeature.RequestCulture">
77 The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> of the request.
80 <member name="P:Microsoft.AspNetCore.Localization.IRequestCultureFeature.Provider">
82 The <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> that determined the request's culture information.
83 If the value is <c>null</c> then no provider was used and the request's culture was set to the value of
84 <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.DefaultRequestCulture"/>.
87 <member name="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider">
89 Represents a provider for determining the culture information of an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
92 <member name="M:Microsoft.AspNetCore.Localization.IRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
94 Implements the provider to determine the culture of the given request.
96 <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the request.</param>
98 The determined <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/>.
99 Returns <c>null</c> if the provider couldn't determine a <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/>.
102 <member name="T:Microsoft.AspNetCore.Localization.ProviderCultureResult">
104 Details about the cultures obtained from <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>.
107 <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(Microsoft.Extensions.Primitives.StringSegment)">
109 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object that has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
110 <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the same culture value.
112 <param name="culture">The name of the culture to be used for formatting, text, i.e. language.</param>
114 <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
116 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
117 <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the respective culture values provided.
119 <param name="culture">The name of the culture to be used for formatting.</param>
120 <param name="uiCulture"> The name of the ui culture to be used for text, i.e. language.</param>
122 <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment})">
124 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object that has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
125 <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the same culture value.
127 <param name="cultures">The list of cultures to be used for formatting, text, i.e. language.</param>
129 <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment},System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment})">
131 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
132 <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the respective culture values provided.
134 <param name="cultures">The list of cultures to be used for formatting.</param>
135 <param name="uiCultures">The list of ui cultures to be used for text, i.e. language.</param>
137 <member name="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures">
139 Gets the list of cultures to be used for formatting.
142 <member name="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures">
144 Gets the list of ui cultures to be used for text, i.e. language;
147 <member name="T:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider">
149 Determines the culture information for a request via values in the query string.
152 <member name="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.QueryStringKey">
154 The key that contains the culture name.
155 Defaults to "culture".
158 <member name="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.UIQueryStringKey">
160 The key that contains the UI culture name. If not specified or no value is found,
161 <see cref="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.QueryStringKey"/> will be used.
162 Defaults to "ui-culture".
165 <member name="M:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
168 <member name="T:Microsoft.AspNetCore.Localization.RequestCulture">
170 Details about the culture for an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
173 <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.Globalization.CultureInfo)">
175 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
176 properties set to the same <see cref="T:System.Globalization.CultureInfo"/> value.
178 <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> for the request.</param>
180 <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.String)">
182 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
183 properties set to the same <see cref="T:System.Globalization.CultureInfo"/> value.
185 <param name="culture">The culture for the request.</param>
187 <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.String,System.String)">
189 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
190 properties set to the respective <see cref="T:System.Globalization.CultureInfo"/> values provided.
192 <param name="culture">The culture for the request to be used for formatting.</param>
193 <param name="uiCulture">The culture for the request to be used for text, i.e. language.</param>
195 <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.Globalization.CultureInfo,System.Globalization.CultureInfo)">
197 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
198 properties set to the respective <see cref="T:System.Globalization.CultureInfo"/> values provided.
200 <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for formatting.</param>
201 <param name="uiCulture">The <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for text, i.e. language.</param>
203 <member name="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture">
205 Gets the <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for formatting.
208 <member name="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture">
210 Gets the <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for text, i.e. language;
213 <member name="T:Microsoft.AspNetCore.Localization.RequestCultureFeature">
215 Provides the current request's culture information.
218 <member name="M:Microsoft.AspNetCore.Localization.RequestCultureFeature.#ctor(Microsoft.AspNetCore.Localization.RequestCulture,Microsoft.AspNetCore.Localization.IRequestCultureProvider)">
220 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCultureFeature"/> with the specified <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.
222 <param name="requestCulture">The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.</param>
223 <param name="provider">The <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>.</param>
225 <member name="P:Microsoft.AspNetCore.Localization.RequestCultureFeature.RequestCulture">
228 <member name="P:Microsoft.AspNetCore.Localization.RequestCultureFeature.Provider">
231 <member name="T:Microsoft.AspNetCore.Localization.RequestCultureProvider">
233 An abstract base class provider for determining the culture information of an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
236 <member name="F:Microsoft.AspNetCore.Localization.RequestCultureProvider.NullProviderCultureResult">
238 Result that indicates that this instance of <see cref="T:Microsoft.AspNetCore.Localization.RequestCultureProvider" /> could not determine the
242 <member name="P:Microsoft.AspNetCore.Localization.RequestCultureProvider.Options">
244 The current options for the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
247 <member name="M:Microsoft.AspNetCore.Localization.RequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
250 <member name="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware">
252 Enables automatic setting of the culture for <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>s based on information
253 sent by the client in headers and logic provided by the application.
256 <member name="M:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Builder.RequestLocalizationOptions})">
258 Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
260 <param name="next">The <see cref="T:Microsoft.AspNetCore.Http.RequestDelegate"/> representing the next middleware in the pipeline.</param>
261 <param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> representing the options for the
262 <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.</param>
264 <member name="M:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
266 Invokes the logic of the middleware.
268 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
269 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the middleware has completed processing.</returns>
271 <member name="T:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions">
273 Extension methods for adding the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to an application.
276 <member name="M:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions.UseRequestLocalization(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
278 Adds the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to automatically set culture information for
279 requests based on information provided by the client.
281 <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
282 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</returns>
284 <member name="M:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions.UseRequestLocalization(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.RequestLocalizationOptions)">
286 Adds the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to automatically set culture information for
287 requests based on information provided by the client.
289 <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
290 <param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> to configure the middleware with.</param>
291 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</returns>
293 <member name="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions">
295 Specifies options for the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
298 <member name="M:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.#ctor">
300 Creates a new <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> with default values.
303 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.DefaultRequestCulture">
305 Gets or sets the default culture to use for requests when a supported culture could not be determined by
306 one of the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s.
307 Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentCulture"/> and <see cref="P:System.Globalization.CultureInfo.CurrentUICulture"/>.
310 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.FallBackToParentCultures">
312 Gets or sets a value indicating whether to set a request culture to an parent culture in the case the
313 culture determined by the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s is not in the
314 <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedCultures"/> list but a parent culture is.
315 Defaults to <c>true</c>;
318 Note that the parent culture check is done using only the culture name.
321 If this property is <c>true</c> and the application is configured to support the culture "fr", but not the
322 culture "fr-FR", and a configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> determines a request's culture is
323 "fr-FR", then the request's culture will be set to the culture "fr", as it is a parent of "fr-FR".
326 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.FallBackToParentUICultures">
328 Gets or sets a value indicating whether to set a request UI culture to a parent culture in the case the
329 UI culture determined by the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s is not in the
330 <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedUICultures"/> list but a parent culture is.
331 Defaults to <c>true</c>;
334 Note that the parent culture check is done using ony the culture name.
337 If this property is <c>true</c> and the application is configured to support the UI culture "fr", but not
338 the UI culture "fr-FR", and a configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> determines a request's UI
339 culture is "fr-FR", then the request's UI culture will be set to the culture "fr", as it is a parent of
343 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedCultures">
345 The cultures supported by the application. The <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> will only set
346 the current request culture to an entry in this list.
347 Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentCulture"/>.
350 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedUICultures">
352 The UI cultures supported by the application. The <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> will only set
353 the current request culture to an entry in this list.
354 Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentUICulture"/>.
357 <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.RequestCultureProviders">
359 An ordered list of providers used to determine a request's culture information. The first provider that
360 returns a non-<c>null</c> result for a given request will be used.
361 Defaults to the following:
363 <item><description><see cref="T:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider"/></description></item>
364 <item><description><see cref="T:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider"/></description></item>
365 <item><description><see cref="T:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider"/></description></item>