Interface ILocalizationService

Namespace

CMS.Core

Assembly

CMS.Core.dll

Localization service interface.

public interface ILocalizationService

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

When localizing resources for builder components and widgets, use IAdminBuildersLocalizationService instead.

Methods

GetString(string, string, bool)

Gets the string by the specified resource key

string GetString(string resourceKey, string culture = null, bool useDefaultCulture = true)

Parameters

resourceKey string

Resource key

culture string

Culture

useDefaultCulture bool

If true the default culture translation is used if translation in chosen culture doesn't exist

Returns

string

LocalizeExpression(string, string, bool, Func<string, string, bool, string>, bool)

Localizes the given expression, handles two types of expressions:

stringkey - Simple localization

=default string|cs-cz=localized string - advanced localization

string LocalizeExpression(string expression, string culture = null, bool encode = false, Func<string, string, bool, string> getStringMethod = null, bool useDefaultCulture = true)

Parameters

expression string

Expression to localize

culture string

Culture to use for localization

encode bool

If true, translations (replacements) are HTML encoded

getStringMethod Func<string, string, bool, string>

Method to get the resource string for localization

useDefaultCulture bool

If true the default culture translation is used if translation in chosen culture doesn't exist

Returns

string

LocalizeString(string, string, bool, bool)

Replaces "{\(stringname\)}" expressions in given text with localized strings using given culture.

string LocalizeString(string inputText, string culture = null, bool encode = false, bool useDefaultCulture = true)

Parameters

inputText string

Input text with localizable expressions

culture string

Culture

encode bool

If true, translations (replacements) are HTML encoded

useDefaultCulture bool

If true the default culture translation is used if translation in chosen culture doesn't exist

Returns

string