| File: ApplicationBuilderExtensions.cs | Web Access |
| Project: src\aspnetcore\src\Middleware\Localization\src\Microsoft.AspNetCore.Localization.csproj (Microsoft.AspNetCore.Localization) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using Microsoft.AspNetCore.Localization; using Microsoft.Extensions.Options; namespace Microsoft.AspNetCore.Builder; /// <summary> /// Extension methods for adding the <see cref="RequestLocalizationMiddleware"/> to an application. /// </summary> public static class ApplicationBuilderExtensions { /// <summary> /// Adds the <see cref="RequestLocalizationMiddleware"/> to automatically set culture information for /// requests based on information provided by the client. /// </summary> /// <param name="app">The <see cref="IApplicationBuilder"/>.</param> /// <returns>The <see cref="IApplicationBuilder"/>.</returns> public static IApplicationBuilder UseRequestLocalization(this IApplicationBuilder app) { ArgumentNullException.ThrowIfNull(app); return app.UseMiddleware<RequestLocalizationMiddleware>(); } /// <summary> /// Adds the <see cref="RequestLocalizationMiddleware"/> to automatically set culture information for /// requests based on information provided by the client. /// </summary> /// <param name="app">The <see cref="IApplicationBuilder"/>.</param> /// <param name="options">The <see cref="RequestLocalizationOptions"/> to configure the middleware with.</param> /// <returns>The <see cref="IApplicationBuilder"/>.</returns> public static IApplicationBuilder UseRequestLocalization( this IApplicationBuilder app, RequestLocalizationOptions options) { ArgumentNullException.ThrowIfNull(app); ArgumentNullException.ThrowIfNull(options); return app.UseMiddleware<RequestLocalizationMiddleware>(Options.Create(options)); } /// <summary> /// Adds the <see cref="RequestLocalizationMiddleware"/> to automatically set culture information for /// requests based on information provided by the client. /// </summary> /// <param name="app">The <see cref="IApplicationBuilder"/>.</param> /// <param name="optionsAction">A callback that configures the <see cref="RequestLocalizationOptions"/>.</param> /// <remarks> /// This will going to instantiate a new <see cref="RequestLocalizationOptions"/> that doesn't come from the services. /// </remarks> /// <returns>The <see cref="IApplicationBuilder"/>.</returns> public static IApplicationBuilder UseRequestLocalization( this IApplicationBuilder app, Action<RequestLocalizationOptions> optionsAction) { ArgumentNullException.ThrowIfNull(app); ArgumentNullException.ThrowIfNull(optionsAction); var options = new RequestLocalizationOptions(); optionsAction.Invoke(options); return app.UseMiddleware<RequestLocalizationMiddleware>(Options.Create(options)); } /// <summary> /// Adds the <see cref="RequestLocalizationMiddleware"/> to automatically set culture information for /// requests based on information provided by the client. /// </summary> /// <param name="app">The <see cref="IApplicationBuilder"/>.</param> /// <param name="cultures">The culture names to be added by the application, which is represents both supported cultures and UI cultures.</param> /// <returns>The <see cref="IApplicationBuilder"/>.</returns> /// <remarks> /// Note that the first culture is the default culture name. /// </remarks> public static IApplicationBuilder UseRequestLocalization( this IApplicationBuilder app, params string[] cultures) { ArgumentNullException.ThrowIfNull(app); ArgumentNullException.ThrowIfNull(cultures); if (cultures.Length == 0) { throw new ArgumentException(Resources.Exception_CulturesShouldNotBeEmpty); } var options = new RequestLocalizationOptions() .AddSupportedCultures(cultures) .AddSupportedUICultures(cultures) .SetDefaultCulture(cultures[0]); return app.UseMiddleware<RequestLocalizationMiddleware>(Options.Create(options)); } }