Simple loadable localizer. More...

Inheritance diagram for Localizer:

Public Member Functions

Localizer ()

Default constructor. More...

void LoadXML (string filepath, CultureInfo? culture=null)

Loads translations for the given culture from a localization configuration file in XML format. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (string filepath, string language)

Loads translations for the given language from a localization configuration file in XML format. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (string filepath, bool merge)

Loads translations for the current localizer language from a localization configuration file in XML format.

Parameters

filepath	Path to the localization configuration file.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the input file cannot be parsed properly.

More...

void LoadXML (Stream stream, CultureInfo? culture=null)

Loads translations for the given culture from a localization configuration file in XML format obtained from a stream. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (Stream stream, string language)

Loads translations for the given language from a localization configuration file obtained in XML format from a stream. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (Stream stream, bool merge)

Loads translations for the current localizer language from a localization configuration file in XML format obtained from a stream.

Parameters

stream	Stream with the localization configuration.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the stream contents cannot be parsed properly.

More...

void LoadXML (XDocument doc, CultureInfo? culture=null)

Loads translations for the given culture from a localization configuration in an XML document. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (XDocument doc, string language)

Loads translations for the given language from a localization configuration in an XML document. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (XDocument doc, bool merge)

Loads translations for the current localizer language from a localization configuration in an XML document.

Parameters

doc	XML document with the localization configuration.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the stream contents cannot be parsed properly.

More...

void LoadXML (Assembly assembly, string resourceName, CultureInfo? culture=null)

Loads translations for the given culture from a localization configuration file in XML format obtained from an embedded resource in the given assembly. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (Assembly assembly, string resourceName, string language)

Loads translations for the given language from a localization configuration file in XML format obtained from an embedded resource in the given assembly. All the translations loaded previously in the localizer are discarded and replaced with the new ones. More...

void LoadXML (Assembly assembly, string resourceName, bool merge)

Loads translations for the current localizer language from a localization configuration file in XML format obtained from an embedded resource in the given assembly.

Parameters

assembly	Assembly that contains the embedded XML file.
resourceName	Name of the embedded resource for the XML file.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException	Thrown when the stream contents cannot be parsed properly.
InvalidOperationException	Thrown when the embedded resource could not be found in the given assembly.

More...

string Localize (PlainString text)

Localizes a string. Converts the base-language string text to its corresponding language-specific localized value. More...

string Localize (FormattableString frmtText)

Localizes an interpolated string. Converts the composite format string of the base-language formattable string frmtText (e.g. an interpolated string) to its corresponding language-specific localized composite format value, and then generates the result by formatting the localized composite format value along with the frmtText arguments by using the formatting conventions of the localizer culture. More...

IEnumerable< string > Localize (IEnumerable< string > texts)

Localizes multiple strings. Converts the base-language strings in texts to their corresponding language-specific localized values. More...

string LocalizeFormat (string format, params object?[] args)

string LocalizeFormat (string format, params object[] args)

Localizes and then formats a string. More...

ContextLocalizer Context (string contextId)

Gets the localizer for a context in the current localizer. Contexts are used to disambiguate the conversion of the same base-language string to different language-specific strings depending on the context where the conversion is performed. More...

ContextLocalizer Context (IEnumerable< string > splitContextIds)

Gets the localizer for a context in the current localizer. Contexts are used to disambiguate the conversion of the same base-language string to different language-specific strings depending on the context where the conversion is performed. More...

Protected Member Functions
void	Clear ()

void	Load (XElement element)

Properties
string	TargetLanguage `[get]`
	Target language of the localizer. More...

CultureInfo	TargetCulture `[get]`
	Target culture of the localizer. More...

Language	Language `[get, set]`

Detailed Description

Simple loadable localizer.

Constructor & Destructor Documentation

◆ Localizer()

Localizer ( )

Default constructor.

Member Function Documentation

◆ Clear()

void Clear ( )

protectedinherited

◆ Context() [1/2]

ContextLocalizer Context ( IEnumerable< string > splitContextIds )

inherited

Gets the localizer for a context in the current localizer. Contexts are used to disambiguate the conversion of the same base-language string to different language-specific strings depending on the context where the conversion is performed.

Implements ILocalizer.

◆ Context() [2/2]

ContextLocalizer Context ( string contextId )

inherited

Gets the localizer for a context in the current localizer. Contexts are used to disambiguate the conversion of the same base-language string to different language-specific strings depending on the context where the conversion is performed.

Implements ILocalizer.

◆ Load()

void Load ( XElement element )

protectedinherited

◆ LoadXML() [1/12]

void LoadXML	(	Assembly	assembly,
		string	resourceName,
		bool	merge
	)

Loads translations for the current localizer language from a localization configuration file in XML format obtained from an embedded resource in the given assembly.

Parameters

assembly	Assembly that contains the embedded XML file.
resourceName	Name of the embedded resource for the XML file.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException	Thrown when the stream contents cannot be parsed properly.
InvalidOperationException	Thrown when the embedded resource could not be found in the given assembly.

Implements ILoadableLocalizer.

◆ LoadXML() [2/12]

void LoadXML	(	Assembly	assembly,
		string	resourceName,
		CultureInfo?	culture = `null`
	)

Loads translations for the given culture from a localization configuration file in XML format obtained from an embedded resource in the given assembly. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [3/12]

void LoadXML	(	Assembly	assembly,
		string	resourceName,
		string	language
	)

Loads translations for the given language from a localization configuration file in XML format obtained from an embedded resource in the given assembly. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [4/12]

void LoadXML	(	Stream	stream,
		bool	merge
	)

Loads translations for the current localizer language from a localization configuration file in XML format obtained from a stream.

Parameters

stream	Stream with the localization configuration.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the stream contents cannot be parsed properly.

Implements ILoadableLocalizer.

◆ LoadXML() [5/12]

void LoadXML	(	Stream	stream,
		CultureInfo?	culture = `null`
	)

Loads translations for the given culture from a localization configuration file in XML format obtained from a stream. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [6/12]

void LoadXML	(	Stream	stream,
		string	language
	)

Loads translations for the given language from a localization configuration file obtained in XML format from a stream. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [7/12]

void LoadXML	(	string	filepath,
		bool	merge
	)

Loads translations for the current localizer language from a localization configuration file in XML format.

Parameters

filepath	Path to the localization configuration file.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the input file cannot be parsed properly.

Implements ILoadableLocalizer.

◆ LoadXML() [8/12]

void LoadXML	(	string	filepath,
		CultureInfo?	culture = `null`
	)

Loads translations for the given culture from a localization configuration file in XML format. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [9/12]

void LoadXML	(	string	filepath,
		string	language
	)

Loads translations for the given language from a localization configuration file in XML format. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [10/12]

void LoadXML	(	XDocument	doc,
		bool	merge
	)

Loads translations for the current localizer language from a localization configuration in an XML document.

Parameters

doc	XML document with the localization configuration.
merge	Replaces the current translations with the loaded ones when<c>false, otherwise merges both (existing translations are overridden with loaded ones).

Exceptions

ParseException Thrown when the stream contents cannot be parsed properly.

Implements ILoadableLocalizer.

◆ LoadXML() [11/12]

void LoadXML	(	XDocument	doc,
		CultureInfo?	culture = `null`
	)

Loads translations for the given culture from a localization configuration in an XML document. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ LoadXML() [12/12]

void LoadXML	(	XDocument	doc,
		string	language
	)

Loads translations for the given language from a localization configuration in an XML document. All the translations loaded previously in the localizer are discarded and replaced with the new ones.

Implements ILoadableLocalizer.

◆ Localize() [1/3]

string Localize ( FormattableString frmtText )

inherited

Localizes an interpolated string. Converts the composite format string of the base-language formattable string frmtText (e.g. an interpolated string) to its corresponding language-specific localized composite format value, and then generates the result by formatting the localized composite format value along with the frmtText arguments by using the formatting conventions of the localizer culture.

Implements ILocalizer.

◆ Localize() [2/3]

IEnumerable< string > Localize ( IEnumerable< string > texts )

inherited

Localizes multiple strings. Converts the base-language strings in texts to their corresponding language-specific localized values.

Implements ILocalizer.

◆ Localize() [3/3]

string Localize ( PlainString text )

inherited

Localizes a string. Converts the base-language string text to its corresponding language-specific localized value.

Implements ILocalizer.

◆ LocalizeFormat() [1/2]

string LocalizeFormat	(	string	format,
		params object?[]	args
	)

inherited

◆ LocalizeFormat() [2/2]

string LocalizeFormat	(	string	format,
		params object[]	args
	)

inherited

Localizes and then formats a string.

Converts the base-language format string format to its corresponding language-specific localized format value, and then generates the result by formatting the localized format value along with the args arguments by using the formatting conventions of the localizer culture.

Parameters

format	Base-language format string.
args	Arguments for the format string.

Returns: Formatted string generated from the language-specific localized format string if found, or generated from format otherwise.

Exceptions

FormatException Thrown when format or its localized format value is invalid.

Implemented in AutoLoadLocalizer.

Property Documentation

◆ Language

Language Language

getsetprotectedinherited

◆ TargetCulture

CultureInfo TargetCulture

getinherited

Target culture of the localizer.

Implements ILocalizer.

◆ TargetLanguage

string TargetLanguage

getinherited

Target language of the localizer.

Implements ILocalizer.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Localizer()

Member Function Documentation

◆ Clear()

◆ Context() [1/2]

◆ Context() [2/2]

◆ Load()

◆ LoadXML() [1/12]

◆ LoadXML() [2/12]

◆ LoadXML() [3/12]

◆ LoadXML() [4/12]

◆ LoadXML() [5/12]

◆ LoadXML() [6/12]

◆ LoadXML() [7/12]

◆ LoadXML() [8/12]

◆ LoadXML() [9/12]

◆ LoadXML() [10/12]

◆ LoadXML() [11/12]

◆ LoadXML() [12/12]

◆ Localize() [1/3]

◆ Localize() [2/3]

◆ Localize() [3/3]

◆ LocalizeFormat() [1/2]

◆ LocalizeFormat() [2/2]

Property Documentation

◆ Language

◆ TargetCulture

◆ TargetLanguage