Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Standard (JavaScript)
The Standard library contains classes for manipulating data of different types and performing common operations.
String (Standard - JavaScript)
Represents a string.
toLocaleString (String - JavaScript)
Gets the string representation of a String object taking into account the host locale.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the IBM® Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
  - Array (Standard - JavaScript)
    Represents an array.
  - Boolean (Standard - JavaScript)
    Represents a boolean value.
  - Date (Standard - JavaScript)
    Represents a date and time.
  - Math (JavaScript)
    Represents common mathematical values and functions.
  - Number (Standard - JavaScript)
    Represents a numeric value.
  - Object (JavaScript)
    Provides common methods for all classes.
  - RegExp (Standard - JavaScript)
  - String (Standard - JavaScript)
    Represents a string.
    - String (String - JavaScript)
      Creates a new String object.
    - charAt (JavaScript)
      Gets the character at a specified index.
    - charCodeAt (JavaScript)
      Gets the character at a specified index as an integer code.
    - compareTo (JavaScript)
      Compares two strings.
    - compareToIgnoreCase (JavaScript)
      Compares two strings ignoring case.
    - concat (Standard - JavaScript)
      Concatenates strings.
    - endsWith (JavaScript)
      Checks whether a string ends with a substring.
    - endsWithIgnoreCase (JavaScript)
      Checks whether a string ends with a substring ignoring case.
    - equals (String - JavaScript)
      Checks whether a string equals another object or string.
    - equalsIgnoreCase (JavaScript)
      Checks whether a string equals another string ignoring case.
    - fromCharCode (JavaScript)
      Creates a string from character codes.
    - hasOwnProperty (String - JavaScript)
      Checks whether a string has a specified property.
    - indexOf (JavaScript)
      Gets the index of a substring.
    - indexOfIgnoreCase (JavaScript)
      Gets the index of a substring ignoring case.
    - insert (JavaScript)
      Inserts a substring.
    - isEmpty (JavaScript)
      Checks whether a string is empty.
    - isStrictEmpty (JavaScript)
      Checks whether a string is empty except for spaces.
    - lastIndexOf (JavaScript)
      Gets the index of the last occurrence of a substring.
    - lastIndexOfIgnoreCase (JavaScript™)
      Gets the index of the last occurrence of a substring ignoring case.
    - left (JavaScript)
      Gets a substring starting at the left.
    - length (JavaScript)
      Gets the length of a string.
    - localeCompare (JavaScript)
      Compares two strings taking into account the host locale.
    - lpad (String - JavaScript)
    - ltrim (JavaScript)
      Removes white space from the left end of a string.
    - match (String - JavaScript)
      Gets substrings that match a regular expression.
    - mid (JavaScript)
      Gets a substring starting at a specified position.
    - prototype (String - JavaScript)
      Extends the object with additional properties and methods.
    - remove (JavaScript)
      Removes a substring.
    - replace (String - JavaScript)
      Replaces a substring.
    - right (JavaScript)
      Gets a substring starting at the right.
    - rpad (JavaScript)
      Fills a string on the right.
    - rtrim (JavaScript)
      Removes white space from the right end of a string.
    - search (String - JavaScript)
      Gets the index of the first occurrence of a substring.
    - slice (String - JavaScript)
      Gets a substring starting and optionally ending at specified positions.
    - split (String - JavaScript)
      Splits a string between string separators.
    - startsWith (JavaScript)
      Checks whether a string starts with a substring.
    - startsWithIgnoreCase (JavaScript)
      Checks whether a string starts with a substring ignoring case.
    - substr (JavaScript)
      Gets a substring.
    - substring (JavaScript)
      Gets a substring.
    - toLocaleLowerCase (JavaScript)
      Converts all characters of a string to lower case taking into account the host locale.
    - toLocaleString (String - JavaScript)
      Gets the string representation of a String object taking into account the host locale.
    - toLocaleUpperCase (JavaScript)
      Converts all characters of a string to upper case taking into account the host locale.
    - toLower (JavaScript)
      Converts all characters of a string to lower case.
    - toLowerCase (JavaScript)
      Converts all characters of a string to lower case.
    - toString (String - JavaScript)
      Gets the string representation of a String object.
    - toUpper (JavaScript)
      Converts all characters of a string to upper case.
    - toUpperCase (JavaScript)
      Converts all characters of a string to upper case.
    - trim (JavaScript)
      Removes white space from both ends of a string.
    - valueOf (String - JavaScript)
      Gets the string as a primitive string.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

toLocaleString (String - JavaScript)

Gets the string representation of a String object taking into account the host locale.

Defined in

Syntax

toLocaleString() : string


Return value	Description
`string`	The string representation of the object.

Examples

The following example gets a String object as a locale string.

cities = new String("Paris   Moscow   Tokyo");
cities.toLocaleString()