ASP.NET Core Localization with help of SharedResources

Question

Hi I have a question about the SharedResources file. It is glanced over in the tutorial here: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/localization, and I'm not sure if I get it correctly.

I am supposed to create a SharedResources.cs class, but where should i put it and should it be empty or do I need to fill it with some data?

Same goes for the resource file, should I create a SharedResources.da.resx file and put all my shared strings there? Where should it go?

And when I use IHtmlLocalizer<SharedResources> do I just write @using and point it to the namespace where SharedResources.cs resides?

I tried putting SharedResources.cs and SharedResources.da.resx in the Resources folder and use it to change website language to Danish, but it does not work. Using dedicated Resource file like Index.da.resx and IViewLocalizer works fine, but IHtmlLocalizer<SharedResources> does not seem to work.

When I looked at the example project linked to at the bottom of the page I didn't find any place where SharedResources is used, it would be great if somebody updated it with an example of that.

Here's how I tried to do it:

Views/Home/Index.cshtml:

@using Funkipedia.Resources
@using Microsoft.AspNetCore.Mvc.Localization
@inject IHtmlLocalizer<Shared> SharedLocalizer
...
<p>@SharedLocalizer["Hei"]</p>
...

At top of ConfigureServices in Startup.cs:

services.AddLocalization(options => options.ResourcesPath = "Resources");
services.AddMvc()
  .AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix)
  .AddDataAnnotationsLocalization();

At top of Configure in Startup.cs:

var supportedCultures = new List<CultureInfo>
{
       new CultureInfo("nb-NO"),
       new CultureInfo("sv-SE"),
       new CultureInfo("da-DK")
};

app.UseRequestLocalization(new RequestLocalizationOptions
{
       DefaultRequestCulture = new RequestCulture("nb-NO"),
       SupportedCultures = supportedCultures,
       SupportedUICultures = supportedCultures
});

Resources folder contains empty class called Shared.cs and Shared.da.resx which contains shared strings. Do I maybe need to change the name of it to SharedResources.cs and SharedResources.da.resx?

Daniel Aaron Salwerowicz · Accepted Answer · 2017-03-07 13:24:22Z

137

Okay, after some digging around and even more trial and error I've found answers to my questions and got everything to work. Here's what I found:

I am supposed to create a SharedResources.cs class, but where should i put it and should it be empty or do I need to fill it with some data?

ANSWER: SharedResources.cs can be placed in the root folder of project or in Resources folder, but the most important thing is that namespace should be set to the root of the project. In my case namespace Funkipedia. And it does not need to contain any data, just the class declaration.

Same goes for the resource file, should I create a SharedResources.da.resx file and put all my shared strings there? Where should it go?

ANSWER: Yes, you need to create a resource file called the same as the .cs file and it needs to be put in the Resources folder.

And when I use IHtmlLocalizer<SharedResources> do I just write @using and point it to the namespace where SharedResources.cs resides?

ANSWER: When it comes to using IHtmlLocalizer and/or IStringLocalizer in view you need to write this at the top of .cshtml file:

@using Microsoft.AspNetCore.Mvc.Localization
@using Microsoft.Extensions.Localization
@inject IViewLocalizer Localizer
@inject IStringLocalizer<SharedResources> SharedLocalizer
@inject IHtmlLocalizer<SharedResources> SharedHtmlLocalizer

Note that @using Microsoft.Extensions.Localization is only needed if you use IStringLocalizer

I hope that this will help others who might be new to resource files and localization of ASP.NET Core applications.

edited Mar 7, 2017 at 13:24

answered Mar 7, 2017 at 13:17

Daniel Aaron Salwerowicz

2,1732 gold badges13 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

12 Comments

sintetico82 Over a year ago

Hi, Do you have any examples of Github?

Daniel Aaron Salwerowicz Over a year ago

Sorry for late reply, here's an easy example I threw together. github.com/MormonJesus69420/SharedResourcesExample

animalito maquina Over a year ago

keep in mind that the ResourcesPath and folders will be case sensitive

Darren Lewis Over a year ago

Great answer. The number of up votes is a good indicator of how ambiguous the MS documentation is on this subject.

YodasMyDad Over a year ago

Lets say you have a .Net core website project with two class libraries referenced. You then can't localise anything in the class libraries as they know nothing about a class placed in the resources folder in the web project?

|

Bo Christian Skjøtt · Accepted Answer · 2018-06-01 20:39:40Z

17

Here is what worked for me (in ASP.NET Core 2.0):

Place SharedResources.cs in a folder called Resources.
Place SharedResources.xx-yy.resx resource files in Resources folder too.
Call services.AddLocalization() with no ResourcesPath option.

answered Jun 1, 2018 at 20:39

Bo Christian Skjøtt

7838 silver badges13 bronze badges

2 Comments

Menol Over a year ago

Adding the culture details to the SharedResources filename isn't necessary (i.e. SharedResource.resx also works) if you are meaning to use SharedResources file across all cultures or just as a culture agnostic string collection.

Vatana7 Apr 22 at 8:34

Thanks, this work for me by removing the ResourcePath option

superjos · Accepted Answer · 2017-07-06 17:47:48Z

10

I'd like to add the setup that's working for my team as well. It's based on the same principle as yours (of course), but I believe it allows some more flexibility on your files location, as it does not force you to put resource-related files in project root.

My understanding is that IStringLocalizer<T> has the concept of a placeholder Type, whose fullname will be converted into a relative path and used to find the actual resource file. To do this conversion, it also uses info from LocalizationOptions.ResourcesPath, if any.

Say you have:

// in ProjectRoot\Startup.cs

services.AddLocalization(opts =>
{
  opts.ResourcesPath = "Localized";
});

// in ProjectRoot\Area\Whatever\SomeClass.cs

namespace Com.Company.Project.Area.Whatever
{
  public class SomeClass
  {
    public SomeClass(IStringLocalizer<SomeClass> localizer)
    {
      // ...
    }
  }
}

So here's what happens, step-by-step, just to give an idea:

SomeClass fullname: Com.Company.Project.Area.Whatever.SomeClass
convert that to .resx file path: Com\Company\Project\Area\Whatever\SomeClass.resx
prefix that with ResourcesPath content: Localized\Com\Company\Project\Area\Whatever\SomeClass.resx

That's the actual path where resource file(s) will be looked up.

So, all in all, you can place your SharedResources.cs empty class wherever you want, as long as you replicate its fullname as a path under ResourcesPath folder under project root.

In the example:

\
--Area
  --Whatever
    --SomeClass.cs
--Localized
  --Com
    --Company
      --Project
        --Area
          --Whatever
            --SomeClass.resx
            --SomeClass.fr.resx
            --SomeClass.da.resx

Under the cover, that directory tree is needed because classes generated out of resx file will take their namespace from the directory tree, and also because string localizer will not strip root namespace when prefixing placeholder type with ResourcesPath.

answered Jul 6, 2017 at 17:47

superjos

12.8k6 gold badges94 silver badges143 bronze badges

4 Comments

Daniel Aaron Salwerowicz Over a year ago

That's really clever, haven't though about that, thanks a lot superjos

superjos Over a year ago

Glad it might help! I've also fiddled with not having any ResourcesPath, thinking that I could place resx files in same directory next to placeholder class, but that did not work and I quit trying shortly after.

Nugsson Over a year ago

I like this approach. The location of SomeClass.cs doesn't matter - it can be in the same folder as the .resx file, as long as you're happy with the namespace of SomeClass not matching the folder structure.

superjos Over a year ago

@Nugsson cool. Did not think about that, as I kinda go by default for the namespace/folder tree match. But I can see how people could prefer not to have those placeholder files separated from the actual resource files.

Gopinath · Accepted Answer · 2021-10-14 15:17:24Z

2

After attempting all answers above, I finally end up with the namespace convention I used!

If your root namespace already has a dot in it ex: MyTestApp.WebAPI, then placing dummy class inside Resources folder doesn't work. Instead, add a dummy class in the project's root directory & let the resources file be in the Resources folder itself.

Reference: https://weblogs.asp.net/ricardoperes/asp-net-core-pitfalls-localization-with-shared-resources

answered Oct 14, 2021 at 15:17

Gopinath

2661 gold badge5 silver badges16 bronze badges

1 Comment

Techy Over a year ago

Thanks a million, after struggling with this for a long time, moving it to root worked

user3533716 · Accepted Answer · 2023-10-11 08:55:29Z

0

For me, I had to add <EmbeddedResourceUseDependentUponConvention>false</EmbeddedResourceUseDependentUponConvention> to the project file. Without it, it defaults to true, which means it tries to take its name in another way, which did not work correctly in my case.

See https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#embeddedresourceusedependentuponconvention

answered Oct 11, 2023 at 8:55

user3533716

5227 silver badges15 bronze badges

Collectives™ on Stack Overflow

ASP.NET Core Localization with help of SharedResources

5 Answers 5

12 Comments

2 Comments

4 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

12 Comments

2 Comments

4 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related