Skip to main content

Localization In .NetCore MVC Application


The translation to a specific region or country or culture or local. The websites with localization can reach a wider range of audiences.

Create A DotNet Core MVC Sample Application:

Let's learn localization steps by implementing them in a sample MVC application.

Add Sample Language Collection To AppSettings File:

In our sample let's read the different languages that we support from the appSettings.json file.
"LanguageCodes": [
  "Name": "Spain",
  "Code": "es"
  "Name": "Mexico",
  "Code": "es-Mx"
  "Name": "United States",
  "Code": "en-us"
Let's create a type for the "LanguageCodes".
namespace Sample.Localization.Mvc.Shared
  public class LanguageCodes
    public string Name { get; set; }
    public string Code { get; set; }
Register the 'LangaugeCodes' Type in DI(Dependency Injection) services so that it can be accessed by injection.
Startup.cs:(ConfigureServices method)

UseRequestLocalization Middleware:

The current culture on request is set in the localization middleware(UseRequestLocalization Middleware). This middleware initializes the RequestLocalization object. On every request, middleware can read the current culture with the following type of providers.
  • QueryStringRequestCultureProvider.
  • CookieRequestCultureProvider.
  • AcceptLanguageHeaderRequestCultureProvider.
From the above providers, we need to understand that 'UseRequestLocalization' middleware tries to read the culture value from the 'query parameter' or 'cookie' or 'accept headers' as per the order we defined above.
private RequestLocalizationOptions RegisterSuportCulture()
  var langCodes = Configuration.GetSection("LanguageCodes").GetChildren().ToList().Select(_ => new LanguageCodes
	Name = _.GetValue<string>("Name"),
	Code = _.GetValue<string>("Code")
  var localizationOptions = new RequestLocalizationOptions()
  .SetDefaultCulture(langCodes.Where(_ => _.Name == "United States")
  .Select(_ => _.Code).FirstOrDefault());
  return localizationOptions;
  • The 'UseRequestLocalization' middleware needs the 'Microsoft.AspNetCore.Builder.RequesLocalizationOption' object. The 'RequesLocalizationOption' object is used to configure all the cultures supported by our application.
  • (Line: 3-7) Reding the culture info from the 'appSettings.Development.json' file.
  • (Line: 9-11) Initialized RequestLocalizationOptions object by setting the default culture for the application.
Now register the 'UseRequestLocalization' middleware above the 'UseRouting' middleware.

UI Dropdown To Change Culture:

In _Layout.cshtml we will configure a dropdown in the menu section to change the culture of the website.

Let's create a partial view to implement the dropdown functionality.
@using Microsoft.Extensions.Options
@using Sample.Localization.Mvc.Shared
@using Microsoft.AspNetCore.Localization;
@inject IOptions<List<LanguageCodes>> _languageCodes
    var requestCulture = Context.Features.Get<IRequestCultureFeature>();
    var cultureName = requestCulture.RequestCulture.Culture.Name;
    var selectionItems = _languageCodes.Value.
        Select(_ => new SelectListItem {
            Text = _.Name,
            Value = _.Code,
            Selected = (_.Code.ToLower() == cultureName.ToLower()) }).ToList();
    var returnUrl = string.IsNullOrEmpty(Context.Request.Path) ? "~/" : $"~{Context.Request.Path.Value}";


<form id="selectLanguage" 
      asp-route-returnUrl="@returnUrl"  >
    <select class="form-control" 
            name="culture" id="culture" 
            onchange="this.form.submit()" asp-items="selectionItems">
  • (Line: 4) Injecting 'LanguageCodes' collection to display them in the dropdown.
  • (Line: 6) Creating an instance of the 'Microsoft.AspNetCore.Localization.IRequestCultureFeature'.
  • (Line: 7) Fetching the current culture of the application, by default it will 'United States' as we configured in the middleware.
  • (Line: 9-12) Creating dropdown item collection.
  • (Line: 13) The current application path will be passed as a post parameter on changing the dropdown value.
  • (Line: 17-28) The Html form that gets post values on changing the dropdown values. The 'asp-controller' and 'asp-action' attributes define endpoint(which we create in the next step) to post the form.
  • The 'asp-route-{your_parameter}' to pass the return URL as post value.

Culture And UI-Culture:

Dotnet supports two culture info objects like 'culture' and 'ui-culture'. The 'culture' is for translation of the text to display. The 'ui-culture' is for translation of date, time, numbers, and currency.

So we have to configure providers like 'SupportedCultures' and 'SupportedUICultures' to the RequesLocalizationOption object. So let's update our 'RegisterSuportCulture' method in the startup class.
Startup.cs:(Update RegisterSuportCulture method)
private RequestLocalizationOptions RegisterSuportCulture()
  var langCodes = Configuration.GetSection("LanguageCodes").GetChildren().ToList().Select(_ => new LanguageCodes
	Name = _.GetValue<string>("Name"),
	Code = _.GetValue<string>("Code")
  var supportedCultures = langCodes.Select(_ => _.Code).ToArray();
  var localizationOptions = new RequestLocalizationOptions().SetDefaultCulture(langCodes.Where(_ => _.Name == "United States").Select(_ => _.Code).FirstOrDefault())
  return localizationOptions;
  • (Line: 8) Creating an array of cultures.
  • (Line: 10-11) The 'AddSupportedCultures' and 'AddSupportedUICultures' configured.

MVC Endpoint Query Param Culture Redirection:

Create an MVC endpoint that get's invoked on dropdown change, this endpoint redirects us with a query parameter contains the value of the culture. Our query parameter should be like 'culture'(translation for text), 'ui-culture'(translation for the date, time, currency etc).
public IActionResult SetLanguage(string culture, string returnUrl)
  returnUrl = $"{returnUrl}?ui-culture={culture}&culture={culture}";
  return LocalRedirect(returnUrl);

Test UI-Culture Translation:

Let's test UI-Culture translation by adding test data on index.cshtml.
 <h5>@(Convert.ToDouble("1777.00").ToString("C2", System.Globalization.CultureInfo.CurrentCulture))</h5>

Resource File:

A resource file contains a translated string for our localization. An example of the resource file is like 'Example.resx'.

The resource file name should be fully qualified for its namespace by excluding the library name. For example, we have 'TestLocalization.dll' and we can create a resource file based on Stratup.cs file like Startup.resx, Spanish translated string). Another example of creating a resource file for HomeContorller can be done with dot notation or folder notation. Coming dot notation file names look like 'Controllers.HomeController.resx', ''. Coming to folder notation file names like 'Resources/Controllers/HomeController.resx', 'Resources/Controllers/'. Similarly, we can create resource files in views(*.cshtml) level also.

Configure Localization Service:

In the Startup.cs file add the following service for accessing and identifying the resource files localization.
Startup.cs:(Inside ConfigureServices Methods)
services.AddLocalization(options => options.ResourcesPath = "Resources");
  • (Line: 1) Giving instruction to check for the resource file inside the 'Resources' folder.
  • (Line: 2) This helps to check files with culture suffix example files like ''(es culture suffix).

Culture Change Using IStringLocalizer:

The IStringLocalizer<T> has the capability to load the translated string based on culture. It has the capability to choose the resource file name based on the culture.
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Localization;

namespace Sample.Localization.Mvc.Controllers
  public class HelloWorldController : Controller
	private readonly IStringLocalizer<HelloWorldController> _stringLocalizer;
	public HelloWorldController(IStringLocalizer<HelloWorldController> stringLocalizer)
		_stringLocalizer = stringLocalizer;
	public IActionResult Index()
		ViewData["Message"] = _stringLocalizer["Hello World"];
		return View();
  • (Line: 15) The 'Hello World' will be the key value of the resource file.
Here implemented resource files using dot notation as below.
For default culture no need to prefix the resource file. Here in our sample default culture is English.

Culture Change Using IHtmlLocalizer:

The IHtmlLocalizer has the capability to load the translated string along with Html tags in it.
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Localization;

namespace Sample.Localization.Mvc.Controllers
  public class GoodMorningController : Controller
	private readonly IHtmlLocalizer<GoodMorningController> _htmlLocalizer;
	public GoodMorningController(IHtmlLocalizer<GoodMorningController> htmlLocalizer)
		_htmlLocalizer = htmlLocalizer;
	public IActionResult Index()
		ViewData["Message"] = _htmlLocalizer["Good Morning"];
		return View();
Here for this sample, we create resource files in the folder structure.

Culture Change Using IViewLocalizer:

The 'IViewLocalizer' is an interface injectable in views to load the translated string from the resource files.
@using Microsoft.AspNetCore.Mvc.Localization
@inject IViewLocalizer _viewLocalizer;
    @_viewLocalizer["Good Morning"]
Here also we created resource file using folder notation as below.

Use Cookie For Culture Change:

Till now we have used query params to change the state of the culture, now we will update our sample to use cookie to save the culture info.
Controllers/HomeController.cs:(Update SetLanguage Action Method)
public IActionResult SetLanguage(string culture, string returnUrl)
   CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(culture)),
   new CookieOptions { Expires = DateTimeOffset.UtcNow.AddYears(1) }
  return LocalRedirect(returnUrl);
That's all about the different approaches to make an application localizable.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the localizing an AspNetCore Mvc application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:


Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T