Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
WPF l10n with bindings
using System.ComponentModel;
using System.Globalization;
using System.Resources;
using System.Windows.Data;
public class TranslationSource
: INotifyPropertyChanged
{
private static readonly TranslationSource instance = new TranslationSource();
public static TranslationSource Instance
{
get { return instance; }
}
private readonly ResourceManager resManager = Properties.Resources.ResourceManager;
private CultureInfo currentCulture = null;
public string this[string key]
{
get { return this.resManager.GetString(key, this.currentCulture); }
}
public CultureInfo CurrentCulture
{
get { return this.currentCulture; }
set
{
if (this.currentCulture != value)
{
this.currentCulture = value;
var @event = this.PropertyChanged;
if (@event != null)
{
@event.Invoke(this, new PropertyChangedEventArgs(string.Empty));
}
}
}
}
public event PropertyChangedEventHandler PropertyChanged;
}
public class LocExtension
: Binding
{
public LocExtension(string name)
: base("[" + name + "]")
{
this.Mode = BindingMode.OneWay;
this.Source = TranslationSource.Instance;
}
}
@meterien

This comment has been minimized.

Copy link

@meterien meterien commented Feb 9, 2017

Thanks!!! This is very useful and work out of the box.

@Logistoner

This comment has been minimized.

Copy link

@Logistoner Logistoner commented Aug 11, 2017

Very nice work indeed. This is in my opinion the most elegant and straightforward approach for multilanguage WPF applications.
I've used this a lot in the recent months and the only thing I was missing was the ability to easily concatenate multiple localized resources into a single string. I was looking into the WPF multibinding feature, but eventually realized this is easily implemented with a slight change in your code.

Usage:
<Label Content="{l:Loc Add_Customer}"/>

...this gives localized resources for keys "Add" and "Customer" separated by a space => "Add Customer" for the default locale.

Code:

private const char KeySeparator = '_';

public string this[string key]
        {
            get
            {
                if (key.IndexOf(KeySeparator)==-1)
                {
                    var res = ResourceManager?.GetString(key, _currentCulture);
                    return !string.IsNullOrWhiteSpace(res) ? res : $"[{key}]";
                }
                else
                {
                    var keys = key.Split(KeySeparator);
                    var results = new List<string>();
                    foreach (var k in keys)
                    {
                        var res = ResourceManager?.GetString(k, _currentCulture);
                        results.Add(!string.IsNullOrWhiteSpace(res) ? res : $"[{k}]");
                    }
                    return string.Join(" ", results);
                }
            }
        }
@ModernRonin

This comment has been minimized.

Copy link

@ModernRonin ModernRonin commented May 30, 2018

works perfectly - super helpful! thanks a lot!

@lpnam0201

This comment has been minimized.

Copy link

@lpnam0201 lpnam0201 commented Jun 11, 2018

Brilliant solution. Thanks a lot.

@eisenreich

This comment has been minimized.

Copy link

@eisenreich eisenreich commented Aug 23, 2018

Very, very, very interesting! This showed me a complete different angle of view how to work with bindings! Thanks! 👍

@ghostelet

This comment has been minimized.

Copy link

@ghostelet ghostelet commented Sep 30, 2018

That looks nice. Do you have any copyright/licensing on this code?

@jakubfijalkowski

This comment has been minimized.

Copy link
Owner Author

@jakubfijalkowski jakubfijalkowski commented Dec 13, 2018

Wow, I didn't expect that much feedback here (and GitHub decided not to notify me - damn you, settings!). It's awesome that you find this useful. Thanks a lot!

@ghostelet - feel free to use it in whatever form you like (w/o copyright notice). You may treat it as public domain.

@Jinjinov

This comment has been minimized.

Copy link

@Jinjinov Jinjinov commented Dec 28, 2018

This is an excellent solution!

Thank you for this and for all your help making a version that works with multiple resource managers

@jimbo26

This comment has been minimized.

Copy link

@jimbo26 jimbo26 commented Sep 23, 2019

Hi,

I am new to c# programming. I am trying to create a multi language app. I can't seem to get it to work. When i copy and paste the codes to project and created resources files. I keep getting error on this line
'private readonly ResourceManager resManager = Properties.Resources.ResourceManager;'
saying the name properties does not exist in current context.

as well

when I try to set the text on my textblook like
' < TextBlock Text="{x:Static ns:Loc t1}" Width="290" / > '
it will result in: Cannot find the member "Loc t1" on the target type.
Can someone help my learn please? thank you

@romaromaniv

This comment has been minimized.

Copy link

@romaromaniv romaromaniv commented Oct 22, 2019

Great solution!

@ghost1372

This comment has been minimized.

Copy link

@ghost1372 ghost1372 commented Mar 26, 2020

tnx

@MarcinSzolke

This comment has been minimized.

Copy link

@MarcinSzolke MarcinSzolke commented May 15, 2020

one of the best solution i have ever seen in regarding to localization. BRILLIANT peace of CODE ! Thank You
it can be used not only for localisation :)
marcin

PS. and i saw a lot of code ...:)

@jakubfijalkowski

This comment has been minimized.

Copy link
Owner Author

@jakubfijalkowski jakubfijalkowski commented Jul 16, 2020

@KaiserWerk: It doesn't really matter where it is, as long as you use correct ResourceManager to get the strings (provided that it is being generated, i.e. the file has correct type in MSBuild). The common location is to put it in Resources directory.

@KaiserWerk

This comment has been minimized.

Copy link

@KaiserWerk KaiserWerk commented Jul 16, 2020

@KaiserWerk: It doesn't really matter where it is, as long as you use correct ResourceManager to get the strings (provided that it is being generated, i.e. the file has correct type in MSBuild). The common location is to put it in Resources directory.

I already got it working, google helped. Thanks a lot to you, too!

@ghost1372

This comment has been minimized.

Copy link

@ghost1372 ghost1372 commented Jul 16, 2020

Unfortunately this method does not support binding to property,I found a better code that also supports binding
You can use the Handycontrols package to use it
github.com/ghost1372/handycontrols

@mhdb96

This comment has been minimized.

Copy link

@mhdb96 mhdb96 commented Aug 12, 2020

Works like a charm!! Thanks man.

@MarcinSzolke

This comment has been minimized.

Copy link

@MarcinSzolke MarcinSzolke commented Aug 12, 2020

everything (property binding) works but it is (da vinci code = to run You must replace one element : ) ) ...
VIEW:

  1. xmlns:local="clr-namespace:MyNamespace.UserInterface.Common.Localization"
  2. <TextBlock Text="{local:LocK name}"/>
  3. the Resource files in the code above default are placed in the PROPERTIES folder(but You can adjust the ResourceManager
    properties
    ):
@nevaran

This comment has been minimized.

Copy link

@nevaran nevaran commented Nov 23, 2020

Since I had a bit of trouble figuring out how to actually use the class, heres examples to help others:

XAML:
xmlns:local="clr-namespace:MyNamespace.LocalizationNamespace"
The namespace for xaml is whatever you set it in the class.

Usage:
"{local:Loc <PropertyName>}"

C#:
Properties.Resources.ResourceManager.GetString(nameof(Properties.Resources.<PROPERTYNAME>), Localization.TranslationSource.Instance.CurrentCulture);

And for switching to the actual culture:
C#:
Localization.TranslationSource.Instance.CurrentCulture = CultureInfo.GetCultureInfo("en-example");

@jakubfijalkowski

This comment has been minimized.

Copy link
Owner Author

@jakubfijalkowski jakubfijalkowski commented Nov 23, 2020

@nevaran - you can check the blog post that I wrote about this. It explains how it works a little bit better (although it might not be fully explanatory).

@nevaran

This comment has been minimized.

Copy link

@nevaran nevaran commented Nov 23, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment