Edit

Share via

CultureInfo class

  • Reference
Package:
@microsoft/sp-page-context

This class is primarily used with the PageContext class. It provides culture info for the current user of the application.

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CultureInfo class.

Properties

currentCultureName

This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons.
currentUICultureName

This string determines the default user interface language. This used for localization and translation of text.
isRightToLeft

This boolean represents the dominant direction of written text for the default user interface language.

Property Details

currentCultureName

This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons.

readonly currentCultureName: string;

Property Value

string

Remarks

This property may be an empty string, but it will never be undefined.

Example: If the currentCultureName is "en-AU" then the application could use this information to display the date as 1/8 instead of 8/1.

currentUICultureName

This string determines the default user interface language. This used for localization and translation of text.

readonly currentUICultureName: string;

Property Value

string

Remarks

This property may have an empty string, but will never be undefined.

Example: If the currentUICultureName is "es-MX", then the application could use this information to translate the word "hello" to "hola".

isRightToLeft

This boolean represents the dominant direction of written text for the default user interface language.

readonly isRightToLeft: boolean;

Property Value

boolean