Skip to main content

WPF Localization - RESX Option

About a year ago I was building a WPF project in .Net 3.0 and Visual Studio 2005. I wanted to revisit this subject and see what has changed in .Net 3.5 and Visual Studio 2008. I will make a few of these posts to try and cover all the different options (RESX option, LocBaml option, Resource Dictionary Option). In this blog I will focus on using a resx file to localize an application.

To show how the resx option is done I created a WPF form with three labels on it. The first label has is text set inline in XAML, the second has it text set via code behind from the resx file and the third has its text set via XAML accessing the resx file.

The first thing that needs to happen to setup a project for localization is a small change to the project file. To make this change you will need to open the project file in notepad (or some other generic editor). In the first PropertyGroup section you need to add the follow XML node <UICulture>en-US</UICulture>. So the project file node would look like this:

image 

 

 

Adding this to the project file config will cause the IDE to create a resource.dll when you compile. Now we need to create our resx file. I like to create a Resources folder to keep my resx files in (You will have to create a resx file for each language you want to have). I created three labels in my XAML to show how this will work.

<Window x:Class="WpfLocalization.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    Title="Window1" Height="300" Width="300"    
    xmlns:properties="clr-namespace:WpfLocalization.Resources">
    <Grid>
        <Label Height="28" Margin="10,13,33,0" 
               Name="lblFromXAML" Content="Text from XAML" 
               VerticalAlignment="Top"></Label>
        <Label Height="28" Margin="10,43,33,0" Name="lblFromResource" 
               VerticalAlignment="Top">Label</Label>
        <Label Height="28" Margin="10,71,33,0" Name="lblXAMLResource" 
               VerticalAlignment="Top"
               Content="{x:Static properties:UIStrings.lblXAMLResource}"></Label>
    </Grid>
</Window>

The first label is just used to show that text in the XAML does not change when we change the culture. The second label will be changed in code using the following:

public Window1()
{
    //UIStrings.Culture = new System.Globalization.CultureInfo("de-DE");
    InitializeComponent();
    
    lblFromResource.Content = UIStrings.lblFromResourcesText;
}

Pretty simple code. You will notice the third label has a binding in the content to do this. In my opinion this is the best way to do this as all your UI display is isolated to the XAML. However, I realize that in an enterprise application you will probably need code to decided what text is displayed (this could be accomplished using a trigger in  your style but that discussion is for another time). In order to do this binding though you have to include the xmlns import to your resx file. You will note that I imported the clr-namespace of WpfLocalization.Resources which is the namespace of my resx file. I can then bind to the static resource of properties:UIStrings.lblXAMLResource which pulls the text for my lblXAMLResource label (I gave my resource string and my label the same name).  When I run the application here is what I get.image Now I can copy my current resx file of UIStrings.resx and make a new resx file called UIStrings.de-DE.resx. I can then edit the text in this new resx file for my German text. The next time I build the compiler will create a secondary resource.dll file for de_DE. If I un-comment the line of code that is commented out above (this code changes the culture form the default of US to de-DE which is Germany) and run the application again I get different text as the resx resource that is used is for my de-DE culture. image I have uploaded the source code for this example as well if you would like to see the entire solution.

You will notice that at the top of the resx editor you have the ability to select rather or not the values in the resx are internal or public. This is new to .Net 3.5 and Visual Studio 2008. In Visual Studio 2005 you could not make these values public. They were always private and there for not accessible to the XAML file via the binding method or accessible to other projects in your solution.

Comments

Seba said…
Your post is not 100% correct. The <UICulture>en-US</UICulture< property in the project file is not needed for the resx option. This will generate a localized sattelite assembly for the en-US culture but this file will only contain the baml localizations. The neutral language resources will be compiled in your main assembly (the classic .NET approach)
Anonymous said…
http://www.codeproject.com/KB/WPF/LocBamlClickOnce.aspx
HariOm said…
This solutions is fine if you have resources public but it won't work with internal resources.
summ3r said…
Hello, Toad! :) If you're interested in a localization tool that can help manage the translation of RESX filex, check out the localization management platform https://poeditor.com/
akhilapriya404 said…
This concept is a good way to enhance the knowledge.thanks for sharing. please keep it up Salesforce Online Training

Popular posts from this blog

MVVM light and Model Validation

I have been using the MVVM light toolkit for a project recently. It is a great toolkit but is missing a couple things and Laurent Bugnion does a good job trying to cover those holes. One of the things the toolkit does not support is Validation. The good news is there is a great CodePlex project out there call Fluent Validation that makes this pretty easy to add and really powerful. My objective was to add validation to my model so I could call “IsValid” on the model itself (similar to the MVC attribute approach). Fluent Validation has you create a new class file that holds you validation rules for a given model. This is the approach I took to enable each model to have an “IsValid” property and a “Errors” property that returns the validation errors.First I setup my ValidationFactory:publicclass ValidatorFactory : FluentValidation.ValidatorFactoryBase{publicoverride FluentValidation.IValidator CreateInstance(Type validatorType) {return SimpleIoc.Default.GetInstance(validatorType) as …

Experience Profile Anonymous, Unknown and Known contacts

When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little.

First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do.

There are a couple key things here to first understand:

Unless you call "IdentifyAs()" for request the contact is always anonymous. Tracking of anonymous contacts is off by default. Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts


Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs" on. I know they say &…

Uniting Testing Expression Predicate with Moq

I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward.Here is what you do for the It.IsAny<> approach in case someone is looking for that. this.bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool>>>())) .Returns(new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an expressi…

Excel XIRR and C#

I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The a…