Class Localization

Inheritance

object

Localization

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Services.Localization

Assembly: DotNetNuke.dll

Syntax

public class Localization

Constructors

Localization()

Declaration

public Localization()

Properties

ApplicationResourceDirectory

Declaration

public static string ApplicationResourceDirectory { get; }

Property Value

Type	Description
string

CurrentCulture

Declaration

public string CurrentCulture { get; }

Property Value

Type	Description
string

CurrentUICulture

Declaration

public string CurrentUICulture { get; }

Property Value

Type	Description
string

ExceptionsResourceFile

Declaration

public static string ExceptionsResourceFile { get; }

Property Value

Type	Description
string

GlobalResourceFile

Declaration

public static string GlobalResourceFile { get; }

Property Value

Type	Description
string

KeyName

Declaration

public static string KeyName { get; set; }

Property Value

Type	Description
string

LocalResourceDirectory

Declaration

public static string LocalResourceDirectory { get; }

Property Value

Type	Description
string

LocalSharedResourceFile

Declaration

public static string LocalSharedResourceFile { get; }

Property Value

Type	Description
string

SharedResourceFile

Declaration

public static string SharedResourceFile { get; }

Property Value

Type	Description
string

ShowMissingKeys

Declaration

public static bool ShowMissingKeys { get; }

Property Value

Type	Description
bool

SupportedLocalesFile

Declaration

public static string SupportedLocalesFile { get; }

Property Value

Type	Description
string

SystemLocale

Declaration

public static string SystemLocale { get; }

Property Value

Type	Description
string

SystemTimeZone

Declaration

public static string SystemTimeZone { get; }

Property Value

Type	Description
string

Methods

ActiveLanguagesByPortalID(int)

Declaration

public static int ActiveLanguagesByPortalID(int portalID)

Parameters

Type	Name	Description
int	portalID

Returns

Type	Description
int

AddLanguageToPortal(int, int, bool)

Declaration

public static void AddLanguageToPortal(int portalID, int languageID, bool clearCache)

Parameters

Type	Name	Description
int	portalID
int	languageID
bool	clearCache

AddLanguageToPortals(int)

Declaration

public static void AddLanguageToPortals(int languageID)

Parameters

Type	Name	Description
int	languageID

AddLanguagesToPortal(int)

Declaration

public static void AddLanguagesToPortal(int portalID)

Parameters

Type	Name	Description
int	portalID

AddTranslatorRole(int, Locale)

Declaration

public static void AddTranslatorRole(int portalID, Locale language)

Parameters

Type	Name	Description
int	portalID
Locale	language

BestCultureCodeBasedOnBrowserLanguages(IEnumerable<string>)

Declaration

public static string BestCultureCodeBasedOnBrowserLanguages(IEnumerable<string> cultureCodes)

Parameters

Type	Name	Description
IEnumerable<string>	cultureCodes

Returns

Type	Description
string

BestCultureCodeBasedOnBrowserLanguages(IEnumerable<string>, string)

Declaration

public static string BestCultureCodeBasedOnBrowserLanguages(IEnumerable<string> cultureCodes, string fallback)

Parameters

Type	Name	Description
IEnumerable<string>	cultureCodes
string	fallback

Returns

Type	Description
string

ConvertLegacyTimeZoneOffsetToTimeZoneInfo(int)

Declaration

public static TimeZoneInfo ConvertLegacyTimeZoneOffsetToTimeZoneInfo(int timeZoneOffsetInMinutes)

Parameters

Type	Name	Description
int	timeZoneOffsetInMinutes

Returns

Type	Description
TimeZoneInfo

DeleteLanguage(Locale)

Declaration

public static void DeleteLanguage(Locale language)

Parameters

Type	Name	Description
Locale	language

DeleteLanguage(Locale, bool)

Declaration

public static void DeleteLanguage(Locale language, bool isInstalling)

Parameters

Type	Name	Description
Locale	language
bool	isInstalling

GetBrowserCulture(int)

Declaration

public static CultureInfo GetBrowserCulture(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
CultureInfo

GetCultureLanguageID(string)

Declaration

public static int GetCultureLanguageID(string cultureCode)

Parameters

Type	Name	Description
string	cultureCode

Returns

Type	Description
int

GetExceptionMessage(string, string)

Declaration

public static string GetExceptionMessage(string key, string defaultValue)

Parameters

Type	Name	Description
string	key
string	defaultValue

Returns

Type	Description
string

GetExceptionMessage(string, string, params object[])

Declaration

public static string GetExceptionMessage(string key, string defaultValue, params object[] @params)

Parameters

Type	Name	Description
string	key
string	defaultValue
object[]	params

Returns

Type	Description
string

GetFixedCurrency(decimal, string, int)

Declaration

public string GetFixedCurrency(decimal expression, string culture, int numDigitsAfterDecimal)

Parameters

Type	Name	Description
decimal	expression
string	culture
int	numDigitsAfterDecimal

Returns

Type	Description
string

GetFixedDate(DateTime, string)

Declaration

public string GetFixedDate(DateTime expression, string culture)

Parameters

Type	Name	Description
DateTime	expression
string	culture

Returns

Type	Description
string

GetLanguageDisplayMode(int)

Declaration

public static string GetLanguageDisplayMode(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
string

GetLocaleName(string, CultureDropDownTypes)

Declaration

public static string GetLocaleName(string code, CultureDropDownTypes displayType)

Parameters

Type	Name	Description
string	code
CultureDropDownTypes	displayType

Returns

Type	Description
string

GetPageLocale(IPortalSettings)

Declaration

public static CultureInfo GetPageLocale(IPortalSettings portalSettings)

Parameters

Type	Name	Description
IPortalSettings	portalSettings

Returns

Type	Description
CultureInfo

GetPageLocale(PortalSettings)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.0. Use overload taking IPortalSettings instead. Scheduled for removal in v11.0.0.")]
public static CultureInfo GetPageLocale(PortalSettings portalSettings)

Parameters

Type	Name	Description
PortalSettings	portalSettings

Returns

Type	Description
CultureInfo

GetResourceFile(Control, string)

Declaration

public static string GetResourceFile(Control control, string fileName)

Parameters

Type	Name	Description
Control	control
string	fileName

Returns

Type	Description
string

GetResourceFileName(string, string, string, int)

Declaration

public static string GetResourceFileName(string resourceFileName, string language, string mode, int portalId)

Parameters

Type	Name	Description
string	resourceFileName
string	language
string	mode
int	portalId

Returns

Type	Description
string

GetSafeJSString(string)

Declaration

public static string GetSafeJSString(string unsafeString)

Parameters

Type	Name	Description
string	unsafeString

Returns

Type	Description
string

GetSafeJSString(string, string)

Declaration

public static string GetSafeJSString(string key, string resourceFileRoot)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot

Returns

Type	Description
string

GetString(string)

Declaration

public static string GetString(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
string

GetString(string, PortalSettings)

Declaration

public static string GetString(string key, PortalSettings portalSettings)

Parameters

Type	Name	Description
string	key
PortalSettings	portalSettings

Returns

Type	Description
string

GetString(string, string)

Declaration

public static string GetString(string key, string resourceFileRoot)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot

Returns

Type	Description
string

GetString(string, string, PortalSettings, string)

Declaration

public static string GetString(string key, string resourceFileRoot, PortalSettings portalSettings, string language)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot
PortalSettings	portalSettings
string	language

Returns

Type	Description
string

GetString(string, string, PortalSettings, string, bool)

Declaration

public static string GetString(string key, string resourceFileRoot, PortalSettings portalSettings, string language, bool disableShowMissingKeys)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot
PortalSettings	portalSettings
string	language
bool	disableShowMissingKeys

Returns

Type	Description
string

GetString(string, string, bool)

Declaration

public static string GetString(string key, string resourceFileRoot, bool disableShowMissingKeys)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot
bool	disableShowMissingKeys

Returns

Type	Description
string

GetString(string, string, string)

Declaration

public static string GetString(string key, string resourceFileRoot, string language)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot
string	language

Returns

Type	Description
string

GetString(string, Control)

Declaration

public static string GetString(string key, Control ctrl)

Parameters

Type	Name	Description
string	key
Control	ctrl

Returns

Type	Description
string

GetStringUrl(string, string)

Declaration

public static string GetStringUrl(string key, string resourceFileRoot)

Parameters

Type	Name	Description
string	key
string	resourceFileRoot

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string, UserInfo)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName, UserInfo userInfo)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string, UserInfo, string)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName, UserInfo userInfo, string resourceFile)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo
string	resourceFile

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string, UserInfo, string, ArrayList)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName, UserInfo userInfo, string resourceFile, ArrayList custom)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo
string	resourceFile
ArrayList	custom

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string, string)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName, string resourceFile)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName
string	resourceFile

Returns

Type	Description
string

GetSystemMessage(PortalSettings, string, string, ArrayList)

Declaration

public static string GetSystemMessage(PortalSettings portalSettings, string messageName, string resourceFile, ArrayList custom)

Parameters

Type	Name	Description
PortalSettings	portalSettings
string	messageName
string	resourceFile
ArrayList	custom

Returns

Type	Description
string

GetSystemMessage(string, PortalSettings, string, UserInfo)

Declaration

public static string GetSystemMessage(string strLanguage, PortalSettings portalSettings, string messageName, UserInfo userInfo)

Parameters

Type	Name	Description
string	strLanguage
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo

Returns

Type	Description
string

GetSystemMessage(string, PortalSettings, string, UserInfo, string, ArrayList)

Declaration

public static string GetSystemMessage(string strLanguage, PortalSettings portalSettings, string messageName, UserInfo userInfo, string resourceFile, ArrayList custom)

Parameters

Type	Name	Description
string	strLanguage
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo
string	resourceFile
ArrayList	custom

Returns

Type	Description
string

GetSystemMessage(string, PortalSettings, string, UserInfo, string, ArrayList, IDictionary, string, int)

Declaration

public static string GetSystemMessage(string strLanguage, PortalSettings portalSettings, string messageName, UserInfo userInfo, string resourceFile, ArrayList customArray, IDictionary customDictionary, string customCaption, int accessingUserID)

Parameters

Type	Name	Description
string	strLanguage
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo
string	resourceFile
ArrayList	customArray
IDictionary	customDictionary
string	customCaption
int	accessingUserID

Returns

Type	Description
string

GetSystemMessage(string, PortalSettings, string, UserInfo, string, ArrayList, string, int)

Declaration

public static string GetSystemMessage(string strLanguage, PortalSettings portalSettings, string messageName, UserInfo userInfo, string resourceFile, ArrayList custom, string customCaption, int accessingUserID)

Parameters

Type	Name	Description
string	strLanguage
PortalSettings	portalSettings
string	messageName
UserInfo	userInfo
string	resourceFile
ArrayList	custom
string	customCaption
int	accessingUserID

Returns

Type	Description
string

LoadCultureDropDownList(DropDownList, CultureDropDownTypes, string)

Declaration

public static void LoadCultureDropDownList(DropDownList list, CultureDropDownTypes displayType, string selectedValue)

Parameters

Type	Name	Description
DropDownList	list
CultureDropDownTypes	displayType
string	selectedValue

LoadCultureDropDownList(DropDownList, CultureDropDownTypes, string, bool)

Declaration

public static void LoadCultureDropDownList(DropDownList list, CultureDropDownTypes displayType, string selectedValue, bool loadHost)

Parameters

Type	Name	Description
DropDownList	list
CultureDropDownTypes	displayType
string	selectedValue
bool	loadHost

LoadCultureDropDownList(DropDownList, CultureDropDownTypes, string, string, bool)

Declaration

public static void LoadCultureDropDownList(DropDownList list, CultureDropDownTypes displayType, string selectedValue, string filter, bool host)

Parameters

Type	Name	Description
DropDownList	list
CultureDropDownTypes	displayType
string	selectedValue
string	filter
bool	host

LoadCultureInListItems(CultureDropDownTypes, string, string, bool)

Declaration

public static IEnumerable<ListItem> LoadCultureInListItems(CultureDropDownTypes displayType, string selectedValue, string filter, bool host)

Parameters

Type	Name	Description
CultureDropDownTypes	displayType
string	selectedValue
string	filter
bool	host

Returns

Type	Description
IEnumerable<ListItem>

LocalizeControlTitle(IModuleControl)

Declaration

public static string LocalizeControlTitle(IModuleControl moduleControl)

Parameters

Type	Name	Description
IModuleControl	moduleControl

Returns

Type	Description
string

LocalizeDataGrid(ref DataGrid, string)

Declaration

public static void LocalizeDataGrid(ref DataGrid grid, string resourceFile)

Parameters

Type	Name	Description
DataGrid	grid
string	resourceFile

LocalizeDetailsView(ref DetailsView, string)

Declaration

public static void LocalizeDetailsView(ref DetailsView detailsView, string resourceFile)

Parameters

Type	Name	Description
DetailsView	detailsView
string	resourceFile

LocalizeGridView(ref GridView, string)

Declaration

public static void LocalizeGridView(ref GridView gridView, string resourceFile)

Parameters

Type	Name	Description
GridView	gridView
string	resourceFile

LocalizeRole(string)

Declaration

public static string LocalizeRole(string role)

Parameters

Type	Name	Description
string	role

Returns

Type	Description
string

LocalizeRoleDescription(string, string)

Declaration

public static string LocalizeRoleDescription(string role, string fallback)

Parameters

Type	Name	Description
string	role
string	fallback

Returns

Type	Description
string

RemoveLanguageFromPortal(int, int)

Declaration

public static void RemoveLanguageFromPortal(int portalID, int languageID)

Parameters

Type	Name	Description
int	portalID
int	languageID

RemoveLanguageFromPortal(int, int, bool)

Declaration

public static void RemoveLanguageFromPortal(int portalID, int languageID, bool isInstalling)

Parameters

Type	Name	Description
int	portalID
int	languageID
bool	isInstalling

RemoveLanguageFromPortals(int)

Declaration

public static void RemoveLanguageFromPortals(int languageId)

Parameters

Type	Name	Description
int	languageId

RemoveLanguageFromPortals(int, bool)

Declaration

public static void RemoveLanguageFromPortals(int languageId, bool isInstalling)

Parameters

Type	Name	Description
int	languageId
bool	isInstalling

RemoveLanguagesFromPortal(int)

Declaration

public static void RemoveLanguagesFromPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

SaveLanguage(Locale)

Declaration

public static void SaveLanguage(Locale locale)

Parameters

Type	Name	Description
Locale	locale

SaveLanguage(Locale, bool)

Declaration

public static void SaveLanguage(Locale locale, bool clearCache)

Parameters

Type	Name	Description
Locale	locale
bool	clearCache

SetLanguage(string)

Declaration

public static void SetLanguage(string value)

Parameters

Type	Name	Description
string	value

SetThreadCultures(CultureInfo, IPortalSettings)

Declaration

public static void SetThreadCultures(CultureInfo cultureInfo, IPortalSettings portalSettings)

Parameters

Type	Name	Description
CultureInfo	cultureInfo
IPortalSettings	portalSettings

SetThreadCultures(CultureInfo, PortalSettings)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.0. Use overload taking IPortalSettings instead. Scheduled for removal in v11.0.0.")]
public static void SetThreadCultures(CultureInfo cultureInfo, PortalSettings portalSettings)

Parameters

Type	Name	Description
CultureInfo	cultureInfo
PortalSettings	portalSettings

Extension Methods

JsonExtensionsWeb.ToJson(object)