The following functions can be used to manipulate and retrieve string details from objects and variables.

These should be written in the following formats:

• variable.function(arguments), example - myVar.subStr(3,2) if your variable name was "myVar" and you wanted to use subStr() to find the 2 characters that begin 3 from the left.

• object.function(arguments), example - city.coords.split(",") if you wanted to split the coordinates of your city into an array to determine the seperate x and y values using the split() function.

Click each function name in the table below for more details of it, with examples.

Functions

CenterPad

Usage: CenterPad(str, targetLength, optional padChar = " ")

Prepends and appends spaces (or specified character) to a string to form string of the desired length.

Example:

• echo CenterPad("This is a test", 25, ".")

Result:

• 19:33:49 (5) - .....This is a test......

charAt

Usage: charAt(#)

Returns the character in the position specified by the index parameter.

Example:

• // Don't forget almost all internal "counting" starts at 0, not at 1...

• // so the 5th character would actually be 0, 1, 2, 3, 4 <--- 4!

• var="hello"
• echo "The 5th letter in the word hello is: " + var.charAt(4)

Result:

• 00:49:44 The 5th letter in the word hello is: o
• 00:49:45 Script stopped

charCodeAt

Usage: charCodeAt(#)

Returns the numeric Unicode character code of the character at the specified index.

Example:

• var="hello"
• echo "The numeric code of the 5th letter in the word hello is: " + var.charCodeAt(4)

Result:

• 01:04:27 The numeric code of the 5th letter in the word hello is: 111
• 01:04:28 Script stopped

concat

Usage: concat(arg1,arg2,...,argN)

Appends the supplied arguments to the end of the String object, converting them to strings if necessary, and returns the resulting string.

Example:

• var="oompa"
• var2="loompa"
• var3="dance"
• echo var.concat(var2," ",var3)

Result:

• 01:06:48 oompaloompa dance
• 01:06:49 Script stopped

fromCharCode

Usage:

Returns a string comprising the characters represented by the Unicode character codes in the parameters.

Example:

Result:

indexOf

Usage:

Searches the string and returns the position of the first occurrence of val found at or after startIndex within the calling string.

Example:

Result:

lastIndexOf

Usage:

Searches the string from right to left and returns the index of the last occurrence of val found before startIndex.

Example:

Result:

LeftPad

Usage: LeftPad(str, targetLength, optional padChar = " ")

Prepends spaces (or specified character) to a string to form string of the desired length.

Example:

• echo LeftPad("This is a test", 25, ".")

Result:

• 19:45:24 ...........This is a test

localeCompare

Usage:

Compares the sort order of two or more strings and returns the result of the comparison as an integer.

Example:

Result:

match

Usage:

Matches the specifed pattern against the string.

Example:

Result:

Merge

Usage: Merge(str1, str2, optional delim = " ")

Concatenate str1 and str2 together, delim is inserted between strings if both strings are not empty.

Example:

• echo Merge("This is a test", "of the Emergency Broadcast System")
• echo Merge("One plus One", "Two", " = ")

Result:

• 19:47:50 (5) - This is a test of the Emergency Broadcast System
• 19:47:54 (5) - One plus One = Two

RightPad

Usage: RightPad(str, targetLength, optional padChar = " ")

Appends spaces (or specified character) to a string to form string of the desired length.

Example:

• echo RightPad("This is a test", 25, ".")

Result:

• 19:46:25 This is a test...........

replace

Usage:

Matches the specifed pattern against the string and returns a new string in which the first match of pattern is replaced with the content specified by repl.

Example:

Result:

search

Usage:

Searches for the specifed pattern and returns the index of the first matching substring.

Example:

Result:

slice

Usage:

Returns a string that includes the startIndex character and all characters up to, but not including, the endIndex character.

Example:

Result:

split

Usage: split("delimiter")

Splits a String object into an array of substrings by dividing it wherever the specified delimiter parameter occurs.

Example:

• mycoords=city.coords.split(",")
• echo "x:" + mycoords[0] + " y:" + mycoords[1]

Result:

• 01:08:42 x:746 y:34
• 01:08:43 Script stopped

StringRepeat

Usage: StringRepeat(count, optional str = " ")

Makes a string consisting of spaces (or of specified string) repeated count times.

Example:

• echo StringRepeat(25, ".")

• echo StringRepeat(25, "Test")

• echo StringRepeat(25, "Test ")

Result:

• 20:12:25 (5) - .........................

• 20:12:30 (5) - TestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTestTest

• 20:13:17 (5) - Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test Test

StringToObject

Usage: StringToObject(str, delim1, delim2, optional result = null)

Parses and converts strings with parameters into object.

Example:

Result:

substr

Usage:

Returns a substring consisting of the characters that start at the specified startIndex and with a length specified by len.

Example:

Result:

substring

Usage:

Returns a string consisting of the character specified by startIndex and all characters up to endIndex - 1.

Example:

Result:

ToCSV

Usage: ToCSV(...args)

Converts arguments to comma-separated string with values enclosedi in qouble quotes.

Example:

• who = "Bob"
• what = "Cap his city"
• when = date()
• echo ToCSV(who, what, when)

Result:

• 19:59:39 (5) - "Bob","Cap his city","Tue Feb 11 19:59:38 GMT-0500 2014"

toLocaleLowerCase

Usage:

Returns a copy of this string, with all uppercase characters converted to lowercase.

Example:

Result:

toLocaleUpperCase

Usage:

Returns a copy of this string, with all lowercase characters converted to uppercase.

Example:

Result:

toLowerCase

Usage:

Returns a copy of this string, with all uppercase characters converted to lowercase.

Example:

Result:

toUpperCase

Usage:

Returns a copy of this string, with all lowercase characters converted to uppercase.

Example:

Result:

Upper1

Usage: Upper1(str)

Upper cases the first letter of a string.

Example:

• echo Upper1("testing")

Result:

• 19:53:50 (5) - Testing

valueOf

Usage:

Returns the primitive value of a String instance.

Example:

Result:

CategoryFunctions