LocalizationHelper Class

Resource manager class that retrieves localized strings from resources.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<LocalizationHelper>
        CMS.Localization.LocalizationHelper

Namespace: CMS.Localization
Assembly: CMS.Localization (in CMS.Localization.dll) Version: 11.0.0

Syntax

public class LocalizationHelper : AbstractHelper<LocalizationHelper>

The LocalizationHelper type exposes the following members.

Constructors

	Name	Description
Public method	LocalizationHelper

Fields

	Name	Description
Public field Static member	MarkLocalizedTexts	If true, the localized texts are marked with special character to be easily recognizable

Properties

	Name	Description
Public property Static member	DefaultManager	Returns default file resource manager.
Protected property	DefaultManagerInternal	Returns default file resource manager.
Public property Static member	DefaultPathPrefix	Default path prefix to be used when resolving path to CMSResources folder. Gets WebApplicationPhysicalPath unless explicitly set. Existing resource file managers must be cleared upon set by calling Clear() for the change to take effect on them. This API supports the framework infrastructure and is not intended to be used directly from your code.
Public property Static member	DefaultResourceFiles	List of the default resource files.
Public property Static member	RegExResourceName	Resource name regular expression.
Public property Static member	UseSQLResourceManagerAsPrimary	If true, SQL Resource manager if used as primary source to retrieve the strings.

Methods

	Name	Description
Public method Static member	Clear	Clears the current instances of the file managers which can retrieve data from the resource files. This will ensure reloading the resource strings from the resource files.
Public method Static member	CreateFileManager	Creates a new instance of file manager.
Public method Static member	GetAPIString(String, String, Boolean)	Returns specified string for the API usage (the default value is used when string is not found).
Public method Static member	GetAPIString(String, String, String, Boolean)	Returns specified string.
Public method Static member	GetCMSResourceFilePath	Gets the path to the resource file.
Public method Static member	GetFileManager	Returns the file resource manager for given culture.
Protected method	GetFileManagerInternal	Returns the file resource manager for given culture.
Public method Static member	GetFileString(String, String, Boolean)	Returns specified string from the resources.
Public method Static member	GetFileString(String, String, String, Boolean)	Returns specified string from the resource files.
Protected method	GetFileStringInternal	Returns specified string from the resource files.
Public method Static member	GetResourceFilePaths	Returns the names of resource files (including their paths) for the specified culture.
Public method Static member	GetResourceName	Trim starting and ending '$' chars, if both exists only. Returns trimmed string.
Public method Static member	GetString(String, Boolean)	Returns specified string.
Public method Static member	GetString(String, String, Boolean)	Returns specified string.
Public method Static member	GetString(String[], String, String, Boolean)	Gets the string using the given string keys. Returns the first available item found.
Public method Static member	GetString(String, String, String, Boolean, Boolean)	Returns specified string.
Public method Static member	GetStringFormat	Gets the given string and formats it with the standard String.Format method
Protected method	GetStringInternal	Returns specified string.
Public method Static member	GetUniqueResStringKey	Returns unique resource string key from given plain text.
Public method Static member	LocalizeExpression	Localizes the given expression, handles two types of expressions: stringkey - Simple localization =default string|cs-cz=localized string - advanced localization
Public method Static member	ResourceFileExistsForCulture	Returns true if resource file exists for given culture.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)