LocalizedString 1.0.3

A simple library that allows for fluent definition of a string and its various translations.

Install-Package LocalizedString -Version 1.0.3
dotnet add package LocalizedString --version 1.0.3
<PackageReference Include="LocalizedString" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LocalizedString --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: LocalizedString, 1.0.3"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install LocalizedString as a Cake Addin
#addin nuget:?package=LocalizedString&version=1.0.3

// Install LocalizedString as a Cake Tool
#tool nuget:?package=LocalizedString&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

A simple library that allows for fluent definition of a string and its various translations. When accessing a defined localized string, Thread.CurrentThread.CurrentCulture will be used to provide the relevant translated value. You can also request a value for a specific culture.

Useful for short strings. If strings are getting longer -- consider switching to time-tested technique of using resource files.

Here is how easy it is to define and use a LocalizedString:

var sampleString = new LocalizedString("chicken")
    .InCanadianEnglish("chicken, eh")
    .InCanadianFrench("éh poulet")
    .InFrench("poulet")
    .InQueensEnglish("hen")
    .In("de", "das bird");

// you can also do
sampleString["en-CA"] = "chicken, eh";
    
// this will output the value based on Thread.CurrentThread.CurrentCulture. If no value is found, Invariant value is used.
Console.WriteLine(sampleString.ToString()); 

When defining a localized string, invariant value must always be supplied. This is the same as for string type. Further to the invariant value, you are free to add translations for various languages.

If you would like to get a value for a particular locale, you can use

sampleString.ToString("en-CA");

// or

sampleString["en-CA"];

If no suitable value is found for that locale, a value for en will be solicited. If no value is found, then invariant value will be returned.

A simple library that allows for fluent definition of a string and its various translations. When accessing a defined localized string, Thread.CurrentThread.CurrentCulture will be used to provide the relevant translated value. You can also request a value for a specific culture.

Useful for short strings. If strings are getting longer -- consider switching to time-tested technique of using resource files.

Here is how easy it is to define and use a LocalizedString:

var sampleString = new LocalizedString("chicken")
    .InCanadianEnglish("chicken, eh")
    .InCanadianFrench("éh poulet")
    .InFrench("poulet")
    .InQueensEnglish("hen")
    .In("de", "das bird");

// you can also do
sampleString["en-CA"] = "chicken, eh";
    
// this will output the value based on Thread.CurrentThread.CurrentCulture. If no value is found, Invariant value is used.
Console.WriteLine(sampleString.ToString()); 

When defining a localized string, invariant value must always be supplied. This is the same as for string type. Further to the invariant value, you are free to add translations for various languages.

If you would like to get a value for a particular locale, you can use

sampleString.ToString("en-CA");

// or

sampleString["en-CA"];

If no suitable value is found for that locale, a value for en will be solicited. If no value is found, then invariant value will be returned.

Release Notes

v1.0.3 - Added In() extension that takes CultureInfo as a paremeter
v1.0.2 - Added German extension
v1.0.1 - Removed implicit operator overload for string as it was causing isses with extensions
v1.0.0 - Initial Release

  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on LocalizedString:

Package Downloads
LocalizedString.FluentValidation
A helper library for FluentValidation that allows for easy declaration of error messages in various languages without the use of resource files

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.3 294 5/14/2019
1.0.1 319 2/12/2019
1.0.0 359 2/12/2019