CultureHelper Class

Provides the global methods for culture helping operations.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<CultureHelper>
        CMS.Helpers.CultureHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 12.0.0

Syntax

public class CultureHelper : AbstractHelper<CultureHelper>

The CultureHelper type exposes the following members.

Constructors

	Name	Description
Public method	CultureHelper

Properties

	Name	Description
Public property Static member	DefaultUICulture	Default culture (default culture of user interface).
Public property Static member	DefaultUICultureCode	Returns default UI culture code.
Protected property	DefaultUICultureCodeInternal	Returns default UI culture code.
Public property Static member	EnglishCulture	English culture (default culture for storing data).
Public property Static member	PreferredUICultureCode	Returns preferred UI culture code.
Public property Static member	PreferredUICultureInfo	Preferred UI culture info object.

Methods

	Name	Description
Public method Static member	GetCultureInfo	Gets the culture info for specified culture. If culture code is invalid, then english culture is returned.
Public method Static member	GetDefaultCultureCode	Returns the default culture code.
Public method Static member	GetFacebookCulture	Obsolete. Converts culture code to Facebook culture code.
Public method Static member	GetOriginalPreferredCulture	Returns the user original preferred culture.
Public method Static member	GetPreferredCulture	Returns the user preferred culture (reflects the virtual context).
Public method Static member	GetPreferredUICultureCode	Returns the user preferred UI Culture code.
Public method Static member	GetShortCultureCode	Returns the short culture part, just the main culture identifier ("en-us" => "en").
Public method Static member	IsCultureRTL	Returns true if specified culture is right to left culture.
Public method Static member	IsNeutralCulture	Checks if culture code is neutral culture code.
Public method Static member	IsPreferredCultureRTL	Returns true is current content culture is right to left culture.
Public method Static member	IsUICultureRTL	Returns true if current UI culture is right to left culture.
Public method Static member	IsValidCultureInfoName	Check if culture code is valid DotNet culture code (All cultures that ship with the .NET Framework, including neutral and specific cultures, cultures installed in the Windows operating system, and custom cultures created by the user).
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	SetPreferredCulture(String)	Sets the user preferred culture.
Public method Static member	SetPreferredCulture(String, Boolean, Boolean)	Sets the user preferred culture.
Public method Static member	SetPreferredUICultureCode	Sets the user preferred UI Culture code.