Beizsoft.Text 1.0.0-rc2

Beizsoft.Text

A simple .NET string localization base library using Names as language and text resource keys.

Comes with BasicLanguage and BasicLanguageManager implementations which use a dictionary under-the-hood, with the ILanguage, ILanguageManager interfaces providing a consistent API, and LanguageManagerBase providing an easily-extensible abstract base class to work with.

An ILanguage has a Name and exposes a bool TryGetText(Name name, out string value) method, while ILanguageManager handles changing the current language bool TrySetLanguage(Name langugage, out ILanguage language), a way of querying available languages IEnumerable<Name> Languages { get; } & bool TryGetLanguage(Name langugage, out ILanguage language) and knowledge of what the currently active language is ILanguage CurrentLanguage { get; }.

There are two approaches to localization enabled by the ILanguageManager.

• bool TryGetText(Name name, out string text)
  • Returns false if the current language has no entry for the requested text resource.
  • text always has a value; when true, it is localized string associated with name for the current language and, when false, is simply name.ToString() for a fallback.
• string GetText(Name name)
  • Always returns a string, either the localized version associated with name for the current language, or name.ToString() as a fallback.

LanguageManagerBase has one abstract property, and two abstract methods:

• IEnumerable<Name> Languages { get; }
  • Requires an actual implementation, used to query available languages.
• bool TryGetLanguage(Name name, out ILanguage<TStringComparer> language)
  • Requires an actual implementation, used to query and change languages.
• void AfterChangingLanguage(ILanguage oldLanguage, ILanguage newLanguage)
  • Can have a noop implementation; called after a language has been changed.
  • Only called when the language is actually changed; is not called if the specified language cannot be found, or if the specified language is already the current language.

All other members are pre-implemented on LangaugeManagerBase. This class can be used to quickly implement a language manager using any storage mechanism you like.