Text Localization
This article explains the different ways to acquire localized texts.
.LocalizedTextCached[(culture, key)] gets a text that is localized to specific 'culture' and 'key'.
// Get text localized to a language
ILocalizedText text = Localization.Default.LocalizedTextCached[(culture: "en", key: "Namespace.Today")];
// Print with 'fi' format provider
string print = text.Print(formatProvider: CultureInfo.GetCultureInfo("fi"), new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
.FormatLocalizedTextCached[((culture, formatProvider) key)] gets a text that is localized to specific 'culture', 'format' and 'key'.
// Get text localized to a language and format provider
ILocalizedText text = Localization.Default.FormatLocalizedTextCached[((culture: "en", format: CultureInfo.GetCultureInfo("fi")), key: "Namespace.Today")];
// Print with the pre-assigned format provider ("fi")
string print = text.Print(formatProvider: null, new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
.LocalizableTextCached[key] gets a text that localizes to the language in provided in the 'formatProvider' parameter.
// Get text
ILocalizableText localizable = Localization.Default.LocalizableTextCached[key: "Namespace.Today"];
// Get format
IFormatProvider format = CultureInfo.GetCultureInfo("fi");
// Print to language indicated by format
string print = localizable.Print(formatProvider: format, new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Tänään on 24.3.2022 13.34.07."
// Localize to "fi"
ILocalizedText localized_fi = localizable.Localize("fi")!.Value;
// Print
WriteLine(localized_fi.Print(new object[] { DateTime.Now })); // "Tänään on 24.3.2022 13.34.07."
.LocalizingTextCached[key] gets a text that localizes to the language in the assigned 'cultureProvider'.
// Create cultrue provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Get automatically localizing text
ILocalizingText localizing = Localization.Default.LocalizingTextCached[(cultureProvider, key: "Namespace.Today")];
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Print to active culture
string print = localizing.Print(new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// Localize to active culture (culture="en", format="fi")
ILocalizedText localized = localizing.Value!.Value;
// Print
WriteLine(localized.Print(new object[] { DateTime.Now })); // "Today is 24.3.2022 13.34.07."
TextLocalizer(localization, cultureProvider, namespace?) localizes texts with the assigned 'cultureProvider'.
// Create culture provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Create text localizer
ITextLocalizer textLocalizer = new TextLocalizer(Localization.Default, cultureProvider);
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Create localized text
ILocalizedText text = textLocalizer["Namespace.Today"]!;
// Print to active culture (culture="en", format="fi")
string print = text.Print(new object[] { DateTime.Now });
// Write
WriteLine(print); // "Today is 24.3.2022 13.34.07."
'namespace' can be supplied in constructor to create keys as "namespace.name".
// Create cultrue provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Create text localizer
ITextLocalizer textLocalizer = new TextLocalizer(Localization.Default, cultureProvider, "Namespace");
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Create localized text (culture="en", format="fi")
ILocalizedText text = textLocalizer["Today"]!;
// Print to active culture
string print = text.Print(new object[] { DateTime.Now });
// Write
WriteLine(print); // "Today is 24.3.2022 13.34.07."
ILocalizer<T>
/// <summary>Base interface for localizer.</summary>
public interface ILocalizer
{
/// <summary>Namespace prefix</summary>
string? Namespace { get; set; }
/// <summary>Resource Type</summary>
Type ResourceType { get; }
/// <summary>Applicable actice culture provider</summary>
ICultureProvider CultureProvider { get; set; }
/// <summary>
/// Get localized resource for <paramref name="name"/>.
///
/// If <see cref="ILocalizer.Namespace"/> or <paramref name="name"/> is null, then counter part is used as key without separator '.'.
/// </summary>
ILocalized? this[string? name] { get; }
}
/// <summary><typeparamref name="T"/> localizer.</summary>
/// <typeparam name="T">Resource type</typeparam>
public interface ILocalizer<out T> : ILocalizer
{
/// <summary>
/// Get localized resource for <paramref name="name"/>.
///
/// If <see cref="ILocalizer.Namespace"/> or <paramref name="name"/> is null, then counter part is used as key without separator '.'.
/// </summary>
new ILocalized<T>? this[string? name] { get; }
}
/// <summary><typeparamref name="T"/> for <typeparamref name="Namespace"/>.</summary>
/// <typeparam name="T">Resource type</typeparam>
/// <typeparam name="Namespace">Key namespace</typeparam>
public interface ILocalizer<T, Namespace> : ILocalizer<T> { }
/// <summary><typeparamref name="T"/> localizer for <typeparamref name="Namespace"/> using <typeparamref name="CultureProvider"/>.</summary>
/// <remarks>This interfaces is typically used with dependency injection.</remarks>
/// <typeparam name="T">Resource type</typeparam>
/// <typeparam name="Namespace">Key namespace</typeparam>
/// <typeparam name="CultureProvider">Culture provider type. Type must have a parameterless constructor.</typeparam>
public interface ILocalizer<T, Namespace, CultureProvider> : ILocalizer<T, Namespace> where CultureProvider : ICultureProvider { }
ILocalizedText
/// <summary></summary>
public interface ILocalizedText : ILocalizationKeyProvider, ICultureProvider, ITemplatePrintable, ITemplateText, ILocalized
{
/// <summary>Choose pluralized version. Each returned variation has same parameter signature.</summary>
ITemplatePrintable Pluralize(object?[]? arguments);
/// <summary>Choose pluralized version. Each returned variation has same parameter signature.</summary>
ITemplateText Pluralize(IFormatProvider? formatProvider, object?[]? arguments);
}
ILocalizableText
/// <summary>Localizable text</summary>
public interface ILocalizableText : ILocalizedText, ILocalizable<ILocalizedText> { }
ILocalizingText
/// <summary>Localizing text</summary>
public interface ILocalizingText : ILocalizedText, ILocalizing<ILocalizedText> { }
ITextLocalizer
/// <summary>Text localizer</summary>
public interface ITextLocalizer : ILocalizer<ITemplatePrintable>
{
/// <summary>
/// Get localized text for key "Namespace.Name".
///
/// If <see cref="ILocalizer.Namespace"/> or <paramref name="name"/> is null, then counter part is used as key without separator '.'.
/// </summary>
new ILocalizedText? this[string? name] { get; }
}
/// <summary>Text localizer</summary>
public interface ITextLocalizer<Namespace> : ITextLocalizer, ILocalizer<ITemplatePrintable, Namespace> { }
/// <summary>Text localizer</summary>
public interface ITextLocalizer<Namespace, CultureProvider> : ITextLocalizer<Namespace>, ILocalizer<ITemplatePrintable, Namespace, CultureProvider> where CultureProvider : ICultureProvider { }
Full Example
Full example
using System.Globalization;
using Avalanche.Localization;
using static System.Console;
class textlocalization
{
public static void Run()
{
{
// <01>
// Get text localized to a language
ILocalizedText text = Localization.Default.LocalizedTextCached[(culture: "en", key: "Namespace.Today")];
// Print with 'fi' format provider
string print = text.Print(formatProvider: CultureInfo.GetCultureInfo("fi"), new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// </01>
}
{
// <02>
// Get text localized to a language and format provider
ILocalizedText text = Localization.Default.FormatLocalizedTextCached[((culture: "en", format: CultureInfo.GetCultureInfo("fi")), key: "Namespace.Today")];
// Print with the pre-assigned format provider ("fi")
string print = text.Print(formatProvider: null, new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// </02>
}
{
// <03>
// Get text
ILocalizableText localizable = Localization.Default.LocalizableTextCached[key: "Namespace.Today"];
// Get format
IFormatProvider format = CultureInfo.GetCultureInfo("fi");
// Print to language indicated by format
string print = localizable.Print(formatProvider: format, new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Tänään on 24.3.2022 13.34.07."
// Localize to "fi"
ILocalizedText localized_fi = localizable.Localize("fi")!.Value;
// Print
WriteLine(localized_fi.Print(new object[] { DateTime.Now })); // "Tänään on 24.3.2022 13.34.07."
// </03>
}
{
// <04>
// Create cultrue provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Get automatically localizing text
ILocalizingText localizing = Localization.Default.LocalizingTextCached[(cultureProvider, key: "Namespace.Today")];
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Print to active culture
string print = localizing.Print(new object[] { DateTime.Now });
// Write to console
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// Localize to active culture (culture="en", format="fi")
ILocalizedText localized = localizing.Value!.Value;
// Print
WriteLine(localized.Print(new object[] { DateTime.Now })); // "Today is 24.3.2022 13.34.07."
// </04>
}
{
// <05>
// Create culture provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Create text localizer
ITextLocalizer textLocalizer = new TextLocalizer(Localization.Default, cultureProvider);
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Create localized text
ILocalizedText text = textLocalizer["Namespace.Today"]!;
// Print to active culture (culture="en", format="fi")
string print = text.Print(new object[] { DateTime.Now });
// Write
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// </05>
}
{
// <06>
// Create cultrue provider
ICultureProvider cultureProvider = new CultureProvider("en");
// Create text localizer
ITextLocalizer textLocalizer = new TextLocalizer(Localization.Default, cultureProvider, "Namespace");
// Assign language
cultureProvider.Culture = "en";
// Assign format
cultureProvider.Format = CultureInfo.GetCultureInfo("fi");
// Create localized text (culture="en", format="fi")
ILocalizedText text = textLocalizer["Today"]!;
// Print to active culture
string print = text.Print(new object[] { DateTime.Now });
// Write
WriteLine(print); // "Today is 24.3.2022 13.34.07."
// </06>
}
}
}