# Global.String

The JavaScript built-in String type.

Availability
0.8
0.8
9.2.0
4.1.0
Extends
Object

# Overview

This module contains Titanium-only extensions for formatting data into locale-specific strings. The target locale is configured by the user in the device's system Settings.

# Methods

# format

Availability
0.8
0.8
9.2.0
4.1.0
format(formatString, ...value) String

Formats a string using printf-style substitution.

The format string follows the IEEE printf specification.

For each "conversion specification" (ie. %s for a string or %d for a number) used inside the string, formatString argument, the respective value is substituted from the argument list. For example:

var forename = 'Paul';
var number = 21;
var message = String.format('Welcome, %s! You are visitor number %d', forename, number);
Ti.API.info(message);

Parameters

Name Type Description
formatString String

An IEEE printf-style string, containing zero or more conversion specifications.

value String | Number

Values to substitute into the formatString. The method expects a variable number of value arguments, one for each % conversion specification in the format string. Optional on Android.

Returns

Formatted string.

Type
String

# formatCurrency

Availability
0.8
0.8
9.2.0
4.1.0
formatCurrency(value) String

Formats a number into the currency format, including currency symbol, of the locale configured for the system.

Parameters

Name Type Description
value Number

Currency value.

Returns

Formatted, localized string.

Type
String

# formatDate

Availability
0.8
0.8
9.2.0
4.1.0
formatDate(date[, format]) String

Formats a date into the date format of the locale configured for the system.

Parameters

Name Type Description
date Date

Date to format.

format String

Date format to use. One of 'short', 'medium', 'long' or 'full'.

Returns

Formatted, localized string.

Type
String

# formatDecimal

Availability
0.8
0.8
9.2.0
4.1.0
formatDecimal(value[, locale[, pattern]]) String

Formats a number into the decimal format, including decimal symbol, of the locale configured for the system.

The localized string created by this method can be parsed be parsed back to a number via the parseDecimal method.

Parameters

Name Type Description
value Number

Value to format.

locale String

Locale string. For example, en-US for US English.

pattern String

Format pattern.

Returns

String representation of the specified number, using a locale-specific decimal symbol, if required.

Type
String

# formatTime

Availability
0.8
0.8
9.2.0
4.1.0
formatTime(date[, format]) String

Formats a date into the time format of the locale configured for the system.

On Android, this method returns the short format.

Parameters

Name Type Description
date Date

Date to format.

format String

Date format to use. One of 'short', 'medium', or 'long' (iOS only.)

Returns

Formatted, localized string.

Type
String