Global.String

The JavaScript built-in String type.

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.

  • 0.8
  • 0.8
  • 0.8
Defined By

Methods

Global.String
( formatString, value ) : String
Formats a string using printf-style substitution. ...

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

  • 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 arugments, one for each % conversion specification in the format string. Optional on Android.

Returns

  • String

    Formatted string.

Global.String
( value ) : String
Formats a number into the currency format, including currency symbol, of the locale configured for the system. ...

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

Parameters

  • value : Number

    Currency value.

Returns

  • String

    Formatted, localized string.

Global.String
( date, [format] ) : String
Formats a date into the date format of the locale configured for the system. ...

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

Parameters

  • date : Date

    Date to format.

  • format : String (optional)

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

Returns

  • String

    Formatted, localized string.

Global.String
( value, [locale], [pattern] ) : String
Formats a number into the decimal format, including decimal symbol, of the locale configured for the system. ...

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

Parameters

  • value : Number

    Value to format.

  • locale : String (optional)

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

  • pattern : String (optional)

    Format pattern.

Returns

  • String

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

Global.String
( date, [format] ) : String
Formats a date into the time format of the locale configured for the system. ...

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

On Android, this method returns the short format.

Parameters

  • date : Date

    Date to format.

  • format : String (optional)

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

Returns

  • String

    Formatted, localized string.