WPFLocalizeExtension Wiki & Documentation Rss Feed

Updated Wiki: NeutralResourcesLanguage in Assembly Manifest

SeriousM — Wed, 08 May 2013 16:35:54 GMT

The Assembly.cs contains sometimes the line [assembly: NeutralResourcesLanguage("en-US", UltimateResourceFallbackLocation.MainAssembly)] which has side effects on resource lookups.

Please remove it.

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Tue, 09 Apr 2013 07:24:06 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

In general, this proxy class triggers the ToString function of the object that is bound to the Source property. It is therefore also applicable to all other kinds of objects where you need value localization.

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above. You may also hide particular enum values using the BrowsableAttribute. A complete example is included in the AssemblyTest example located in the source code of the library.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Tue, 09 Apr 2013 07:23:17 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

This proxy class triggers the ToString function of the object that is bound to the Source property and is therefore in general applicable to all kinds of objects.

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above. You may also hide particular enum values using the BrowsableAttribute. A complete example is included in the AssemblyTest example located in the source code of the library.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: Home

MrCircuit — Tue, 09 Apr 2013 07:22:07 GMT

The Localization Extension...

... is the easiest way to localize any type of DependencyProperties or native Properties on DependencyObjects under WPF & Silverlight.

Feature Demo:

Launch in another window

Version 2.1.3 arrived

Besides some fixes to bugs & feature requests that accumulated in the past months, a brand new feature is included. Check out the LocProxy & EnumComboBox section of the Wiki pages for more detail about this.

Products that use this Solution:

SAP Crystal Reports, Version for Visual Studio .NET

Features:

First of all: ITS FREE (and will stay free)
Obtain stable results in
- WPF applications using .NET 3.5 and higher
- New: Silverlight 5.0 applications
- New: Windows Phone 7.x applications
New: Localization source/provider can be changed freely at arbitrary nodes
- Use the Provider property in LocalizeDictionary to change the provider for the particular sub tree
- Use the DefaultProvider property to set the provider for the whole application
- Built-in RESX provider for resource file lookup (Default) - fully backward compatible to older versions of this extension
- Interface for custom providers
- Notification about provider changes and errors
- Get the list of all available cultures from a provider - or just take the bindable merged list from LocalizeDictionary
- CSV provider project in the Tests folder as an example for custom providers
Supports binding-like write style like "Text = {lex:LocText ResAssembly:ResFile:ResKey}"
- Define a default assembly and / or resource file to reduce the key to ResAssembly::ResKey, ResFile:ResKey or even ResKey
- If no key is specified, the Name and Property Name of the target are used (e.g. MyButton_Content)
- Default assembly, dictionary and culture can be changed dynamically
- Default assembly and dictionary inherit along the visual tree and can be redefined at each node
It is available at designtime (MS Expression Blend 3.0 & 4.0, MS VisualStudio 2008 & 2010
- not for dynamic loaded assemblies which only can be found at runtime and as long the resource (.resx) is built at designtime
- Even for Silverlight!
- No extra preview application needed
- Offers a DesignValue Property to support custom values during design mode
Full support of various application scenarios
- Works with normal dependency properties
- Works with normal properties (e.g. Ribbon)
- Works with control/data templates
Various culture setup features
- Works with the .resx-fallback mechanism (e.g. en-us -> en -> invariant culture)
- Supports culture forcing (e.g. "this object has to be in english all the time")
- Buffering allows fast switching of the language at runtime
- Offers a design language for visual testing at designtime
- Offers a "SpecificCulture" to use as IFormatProvider (e.g. (123.20).ToString(LocalizeDictionary.SpecificCulture) = "123.20" or "123,20")
- Does not alter the culture on Thread.CurrentCulture or Thread.CurrentUICulture (can be changed easily)
Code behind features:
- Can be used in code behind to bind localized values to dynamic generated controls
- Implements INotifyPropertyChanged for advanced use
- Offers some functionality to check and get resource values in code behind (e.g. ResolveLocalizedValue)
Easy to use
- Can be used with any resource file (.resx) accross all assemblies (also the dynamic loaded one at runtime)
- Does not need any initializing process (like "call xyz to register a special localize dictionary")
- Can localize any type of data type, as long a TypeConverter exists for it
Example extensions included for
- Formating e.g. "this is the '{0}' value" (not bindable at the moment)
- Prefix and suffix values (currently with LocText extension)
- Upper and lower Text
Last, but not least
- Does not create any memory leaks
- Leaves the UID property untouched
- Does not need an additional build task
- Is in use in various productive systems

WPF Localization Addin:

WPF Localization Addin, hosted by skiba_k
thanks for this!

You can do a donation to me and my work.
It would be very nice of you :)

Please let me know your Feedback or send me a message if you are using this extension in your projects!
It would be nice if you would call me your company and whether i have the permission to set it on the references.

NEWS

20130408: Version 2.1.3 ready for download

20121112: Version 2.1.2 ready for download

20121017: Version 2.1.1 ready for download

20120706: Version 2.1.0 ready for download

20120626: Beta 2.1.0 ready for download

20120620: Version 2.0.0 ready for download

20120619: Beta 2.0.0 ready for download

20120615: We got a documentation! ...ehm - finally :-)

20120614: The Localization Extension is now also supporting Silverlight 5.0 applications! Check out the latest source at GitHub or NuGet package

20120521: I'm proud to announce that WPF Localization Extension is prepared for the future! It's now build on top of XAML Markup Extensions by MrCircuit

20120116: NuGet Package arrived! https://nuget.org/packages/WpfLocalizeExtension/

20111103: I've added the source code to Github: https://github.com/SeriousM/WPFLocalizationExtension
Now can everyone make a fork easily! go for it :)

20110725: The SVN Repository (Source Code Section) is now updated. (the project is still alive and will be monitored well by me)

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Mon, 08 Apr 2013 06:33:26 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

This proxy is class triggers the ToString function of the object that is bound to the Source property and is therefore in general applicable to all kinds of objects.

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above. You may also hide particular enum values using the BrowsableAttribute. A complete example is included in the AssemblyTest example located in the source code of the library.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:51:07 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above. A complete example is included in the AssemblyTest example located in the source code of the library.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:50:49 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above. A complete example is included in the AssemblyTest use case located in the source code of the library.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: Home

MrCircuit — Sun, 07 Apr 2013 23:49:56 GMT

The LocalizationExtension...

... is the easiest way to localize any type of DependencyProperties or native Properties on DependencyObjects under WPF & Silverlight.

Feature Demo:

Launch in another window

Version 2.1.3 arrived

Products that use this Solution:

SAP Crystal Reports, Version for Visual Studio .NET

Features:

First of all: ITS FREE (and will stay free)
Obtain stable results in
- WPF applications using .NET 3.5 and higher
- New: Silverlight 5.0 applications
- New: Windows Phone 7.x applications
New: Localization source/provider can be changed freely at arbitrary nodes
- Use the Provider property in LocalizeDictionary to change the provider for the particular sub tree
- Use the DefaultProvider property to set the provider for the whole application
- Built-in RESX provider for resource file lookup (Default) - fully backward compatible to older versions of this extension
- Interface for custom providers
- Notification about provider changes and errors
- Get the list of all available cultures from a provider - or just take the bindable merged list from LocalizeDictionary
- CSV provider project in the Tests folder as an example for custom providers
Supports binding-like write style like "Text = {lex:LocText ResAssembly:ResFile:ResKey}"
- Define a default assembly and / or resource file to reduce the key to ResAssembly::ResKey, ResFile:ResKey or even ResKey
- If no key is specified, the Name and Property Name of the target are used (e.g. MyButton_Content)
- Default assembly, dictionary and culture can be changed dynamically
- Default assembly and dictionary inherit along the visual tree and can be redefined at each node
It is available at designtime (MS Expression Blend 3.0 & 4.0, MS VisualStudio 2008 & 2010
- not for dynamic loaded assemblies which only can be found at runtime and as long the resource (.resx) is built at designtime
- Even for Silverlight!
- No extra preview application needed
- Offers a DesignValue Property to support custom values during design mode
Full support of various application scenarios
- Works with normal dependency properties
- Works with normal properties (e.g. Ribbon)
- Works with control/data templates
Various culture setup features
- Works with the .resx-fallback mechanism (e.g. en-us -> en -> invariant culture)
- Supports culture forcing (e.g. "this object has to be in english all the time")
- Buffering allows fast switching of the language at runtime
- Offers a design language for visual testing at designtime
- Offers a "SpecificCulture" to use as IFormatProvider (e.g. (123.20).ToString(LocalizeDictionary.SpecificCulture) = "123.20" or "123,20")
- Does not alter the culture on Thread.CurrentCulture or Thread.CurrentUICulture (can be changed easily)
Code behind features:
- Can be used in code behind to bind localized values to dynamic generated controls
- Implements INotifyPropertyChanged for advanced use
- Offers some functionality to check and get resource values in code behind (e.g. ResolveLocalizedValue)
Easy to use
- Can be used with any resource file (.resx) accross all assemblies (also the dynamic loaded one at runtime)
- Does not need any initializing process (like "call xyz to register a special localize dictionary")
- Can localize any type of data type, as long a TypeConverter exists for it
Example extensions included for
- Formating e.g. "this is the '{0}' value" (not bindable at the moment)
- Prefix and suffix values (currently with LocText extension)
- Upper and lower Text
Last, but not least
- Does not create any memory leaks
- Leaves the UID property untouched
- Does not need an additional build task
- Is in use in various productive systems

Get the latest NuGet package at:

https://nuget.org/packages/WpfLocalizeExtension/

Get the source code at:

https://github.com/SeriousM/WPFLocalizationExtension

Documentation & Tutorial

Documentation

WPF Localization Addin:

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:48:13 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:48:02 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

Beginning with v2.1.3 the extension also features an Enum value localization technique. To achieve this one has to employ the new LocProxy class. Just pass the particular enum value to the Source property and check the right setting of the PrependType flag. If this is used, you may also specify a Separator that will be used between the type suffix and the value itself leading to key entries like this "MyEnum_MyValue" using underscore as the separator. This allows us to create unique localization keys for different enum types and their values. To get the localized value, just bind your text element to the Result property of the LocProxy:

{code:xml}
<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />{code:xml}
To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:47:35 GMT

Usage

LocProxy & EnumComboBox - listing localized enum values

<lex:LocProxy Source="{Binding}" x:Name="Proxy" PrependType="True" />
<TextBlock Text="{Binding Result, ElementName=Proxy}" Margin="2" FontWeight="Normal" />

To enhance this feature, also an EnumComboBox class was introduced with v2.1.3. Just feed your enum type to the Type property of this class and it does the rest for you, provided, that you correctly style the entries, e.g. using the XAML code snippet from above.

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: Documentation

MrCircuit — Sun, 07 Apr 2013 23:37:39 GMT

Documentation

Introduction

Usage

MVVM best practices

Binding - Do's and Don'ts
tbd

Common mistakes

Important notes on Silverlight

Add all cultures to the <SupportedCultures> tag of the Silverlight project file!

Updated Wiki: Localization providers

MrCircuit — Sun, 07 Apr 2013 23:37:11 GMT

Usage

Localization providers

The project was restructured to separate the target identification and value conversion in the markup extension from the logic that actually provides the value by introducing the ILocalizationProvider interface. This enables us to plug in other provider services without touching the base, the LocExtension.

Changing the provider

The provider can be changed using the LocalizeDictionary.Provider attached property at any node in the XAML document. Depending on the provider, a static singleton reference (e.g. resx provider) or an instance (e.g. csv provider) must be assigned to this property.

The default provider is set to the ResxLocalizationProvider. If you need another application wide default provider, just overwrite the static backed-up attached property LocalizeDictionary.DefaultProvider.

Provider features

Besides its localized look up functionality, providers can give you a list of available cultures. This observable collection can be read out or bound - whatever you need or prefer. The list is additionally observed by the LocalizeDictionary instance providing a merged bindable list of all available cultures.

Furthermore, providers fire events, when critical values in the provider changed (triggering an update of the LocExtension) or when an error occured.

Implementing custom providers

To implement your own provider, create a class that implements the ILocalizationProvider interface. There is no restriction concerning its base class.

public interface ILocalizationProvider
{
    /// <summary>
    /// Get the localized object.
    /// </summary>
    /// <param name="key">The key to the value.</param>
    /// <param name="target">The target <see cref="DependencyObject"/>.</param>
    /// <param name="culture">The culture to use.</param>
    /// <returns>The value corresponding to the key and culture.</returns>
    object GetLocalizedObject(string key, DependencyObject target, CultureInfo culture);

    /// <summary>
    /// An observable list of available cultures.
    /// </summary>
    ObservableCollection<CultureInfo> AvailableCultures { get; }

    /// <summary>
    /// An event when the provider changed.
    /// </summary>
    event ProviderChangedEventHandler ProviderChanged;

    /// <summary>
    /// An event when an error occurred.
    /// </summary>
    event ProviderErrorEventHandler ProviderError;
}

You can then assign your own provider to the properties of LocalizeDictionary.

Previous topic: Multiple assemblies and dictionaries
Next topic: LocProxy & EnumComboBox

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:36:52 GMT

Usage

LocProxy & EnumComboBox

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: LocProxy & EnumComboBox

MrCircuit — Sun, 07 Apr 2013 23:36:26 GMT

Usage

LocProxy & EnumComboBox

Previous topic: Localization providers
Next topic: Important notes on Silverlight > Design-time limitations

Updated Wiki: Home

MrCircuit — Sun, 07 Apr 2013 23:34:04 GMT

The LocalizationExtension...

... is the easiest way to localize any type of DependencyProperties or native Properties on DependencyObjects under WPF & Silverlight.

Feature Demo:

Launch in another window

Version 2.1.3 arrived

Products that use this Solution:

SAP Crystal Reports, Version for Visual Studio .NET

Features:

First of all: ITS FREE (and will stay free)
Obtain stable results in
- WPF applications using .NET 3.5 and higher
- New: Silverlight 5.0 applications
- New: Windows Phone 7.x applications
New: Localization source/provider can be changed freely at arbitrary nodes
- Use the Provider property in LocalizeDictionary to change the provider for the particular sub tree
- Use the DefaultProvider property to set the provider for the whole application
- Built-in RESX provider for resource file lookup (Default) - fully backward compatible to older versions of this extension
- Interface for custom providers
- Notification about provider changes and errors
- Get the list of all available cultures from a provider - or just take the bindable merged list from LocalizeDictionary
- CSV provider project in the Tests folder as an example for custom providers
Supports binding-like write style like "Text = {lex:LocText ResAssembly:ResFile:ResKey}"
- Define a default assembly and / or resource file to reduce the key to ResAssembly::ResKey, ResFile:ResKey or even ResKey
- If no key is specified, the Name and Property Name of the target are used (e.g. MyButton_Content)
- Default assembly, dictionary and culture can be changed dynamically
- Default assembly and dictionary inherit along the visual tree and can be redefined at each node
It is available at designtime (MS Expression Blend 3.0 & 4.0, MS VisualStudio 2008 & 2010
- not for dynamic loaded assemblies which only can be found at runtime and as long the resource (.resx) is built at designtime
- Even for Silverlight!
- No extra preview application needed
- Offers a DesignValue Property to support custom values during design mode
Full support of various application scenarios
- Works with normal dependency properties
- Works with normal properties (e.g. Ribbon)
- Works with control/data templates
Various culture setup features
- Works with the .resx-fallback mechanism (e.g. en-us -> en -> invariant culture)
- Supports culture forcing (e.g. "this object has to be in english all the time")
- Buffering allows fast switching of the language at runtime
- Offers a design language for visual testing at designtime
- Offers a "SpecificCulture" to use as IFormatProvider (e.g. (123.20).ToString(LocalizeDictionary.SpecificCulture) = "123.20" or "123,20")
- Does not alter the culture on Thread.CurrentCulture or Thread.CurrentUICulture (can be changed easily)
Code behind features:
- Can be used in code behind to bind localized values to dynamic generated controls
- Implements INotifyPropertyChanged for advanced use
- Offers some functionality to check and get resource values in code behind (e.g. ResolveLocalizedValue)
Easy to use
- Can be used with any resource file (.resx) accross all assemblies (also the dynamic loaded one at runtime)
- Does not need any initializing process (like "call xyz to register a special localize dictionary")
- Can localize any type of data type, as long a TypeConverter exists for it
Example extensions included for
- Formating e.g. "this is the '{0}' value" (not bindable at the moment)
- Prefix and suffix values (currently with LocText extension)
- Upper and lower Text
Last, but not least
- Does not create any memory leaks
- Leaves the UID property untouched
- Does not need an additional build task
- Is in use in various productive systems

Get the latest NuGet package at:

https://nuget.org/packages/WpfLocalizeExtension/

Get the source code at:

https://github.com/SeriousM/WPFLocalizationExtension

Documentation & Tutorial

Documentation

WPF Localization Addin:

New Comment on "Resource files"

winromulus — Sat, 02 Mar 2013 03:22:10 GMT

For SL it should be noted that <SupportedCultures>en,de</SupportedCultures> needs to be added to the project file or else it won't work.

Updated Wiki: Documentation

MrCircuit — Fri, 18 Jan 2013 20:10:24 GMT

Documentation

Introduction

Usage

MVVM best practices

Binding - Do's and Don'ts
tbd

Common mistakes

Important notes on Silverlight

Add all cultures to the <SupportedCultures> tag of the Silverlight project file!

New Comment on "Access modifier for resource assemblies"

steffenW — Mon, 14 Jan 2013 12:00:16 GMT

this totally contradics what is stated in Documentation > Resource Files. Either I set the AccessModifier to Internal/Public or I set it to 'No code generation' (which is said in Resource Files: "The Custom Tool property of the main resource file (ResXFileCodeGenerator), the others leave this field empty").

New Comment on "Resource files"

MichaelGiger — Thu, 27 Dec 2012 14:15:14 GMT

After adding new keys (in Resourcefile (ResX)) and rebuild the project I can't see it in design time! It works only if I close and reload the project solution. (Visual Studio 2012)