View Source

length

Gives the length of the string.

Methods Summary

anchor(nameAttribute)

returns a copy of the string embedded within an anchor <A> tag set.

big()

returns a copy of the string embedded within an <BIG> tag set.

blink()

returns a copy of the string embedded within an <BLINK> tag set.

bold()

returns a copy of the string embedded within an tag set.

charAt(index)

returns a character of the string.

charCodeAt(index)

returns a decimal code of the char in the string.

concat(string2)

returns a string that appends the parameter string to the string.

concat(string2, stringN)

returns a string that appends the parameter string to the string.

endsWith(searchString)

Determines whether a string ends with the characters of a specified string, returning true or false as appropriate.

endsWith(searchString, length)

Determines whether a string ends with the characters of a specified string, returning true or false as appropriate.

equals(other)

returns a boolean that checks if the given string is equal to the string

equalsIgnoreCase(other)

returns a boolean that checks if the given string is equal to the string ignoring case

fixed()

returns a copy of the string embedded within an anchor <TT> tag set.

fontcolor(color)

returns a copy of the string embedded within an tag set, the color param is assigned the the color attribute.

fontsize(size)

returns a copy of the string embedded within an tag set, The size param is set to the SIZE attribute

fromCharCode(num)

returns a string created by using the specified sequence of Unicode values.

includes()

Determines whether one string may be found within another string.

indexOf(searchValue, fromIndex)

returns the found index of the given string in string.

italics()

returns a copy of the string embedded within an tag set

lastIndexOf(searchValue, fromIndex)

returns the found index of the given string in string from the end.

link(hrefAttribute)

returns a copy of the string embedded within an <A> tag set.

localeCompare(otherString)

Array

match(regexp)

returns an array of strings within the current string that matches the regexp.

normalize()

Returns the Unicode Normalization Form of the string.

normalize(form)

Returns the Unicode Normalization Form of the string.

repeat(count)

Constructs and returns a new string which contains the specified number of copies of the string on which it was called, concatenated together.

replace(regexp, function)

returns a new string where the matches of the given regexp are replaced by the return value of the function.

replace(regexp, newSubStr)

returns a new string where the matches of the given reg exp are replaced by newSubStr.

replace(substr, function)

returns a new string where the first match of the given substr is replaced by the return value of the function.

replace(substr, newSubStr)

returns a new string where the first match of the given substr is replaced by newSubStr.

search(regexp)

returns an index where the first match is found of the regexp

slice(beginSlice)

returns a substring of the string.

slice(beginSlice, endSlice)

returns a substring of the string.

small()

returns a copy of the string embedded within an tag set.

split(separator, limit)

returns an array of objects whose elements are segments of the current string.

split(separator, limit)

returns an array of objects whose elements are segments of the current string.

startsWith(searchString)

Determines whether a string begins with the characters of a specified string, returning true or false as appropriate.

startsWith(searchString, position)

Determines whether a string begins with the characters of a specified string, returning true or false as appropriate.

strike()

returns a copy of the string embedded within an <STRIKE> tag set.

sub()

returns a copy of the string embedded within an tag set.

substr(start)

returns a substring of the string from the start with the number of chars specified.

substr(start, length)

returns a substring of the string from the start with the number of chars specified.

substring(indexA)

Returns a substring of the string from the start index until the end index.

substring(indexA, indexB)

Returns a substring of the string from the start index until the end index.

sup()

returns a copy of the string embedded within an tag set.

returns a string with all lowercase letters of the current string.

toUpperCase()

returns a string with all uppercase letters of the current string.

trim()

Returns the string stripped of whitespace from both ends.

Property Details

length

Gives the length of the string.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.length;

Methods Details

anchor(nameAttribute)

returns a copy of the string embedded within an anchor &lt;A&gt; tag set.

Parameters

nameAttribute

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.anchor();

big()

returns a copy of the string embedded within an &lt;BIG&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.big();

blink()

returns a copy of the string embedded within an &lt;BLINK&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.blink();

bold()

returns a copy of the string embedded within an &lt;B&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.bold();

charAt(index)

returns a character of the string.

Parameters

index

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.charAt(integer_position);

charCodeAt(index)

returns a decimal code of the char in the string.

Parameters

index

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.charCodeAt(integer_position);

concat(string2)

returns a string that appends the parameter string to the string.

Parameters

string2

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.concat(string);

concat(string2, stringN)

returns a string that appends the parameter string to the string.

Parameters

string2

;

stringN

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.concat(string);

endsWith(searchString)

Determines whether a string ends with the characters of a specified string, returning true or false as appropriate.

Parameters

searchString

The characters to be searched for at the end of str.

Returns

true if the given characters are found at the end of the string; otherwise, false

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var str1 = 'Cats are the best!';
 application.output(str1.endsWith('best', 17));

endsWith(searchString, length)

Determines whether a string ends with the characters of a specified string, returning true or false as appropriate.

Parameters

searchString

The characters to be searched for at the end of str.

length

If provided, it is used as the length of str. Defaults to str.length.

Returns

true if the given characters are found at the end of the string; otherwise, false

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var str1 = 'Cats are the best!';
 application.output(str1.endsWith('best', 17));

equals(other)

returns a boolean that checks if the given string is equal to the string

Parameters

other

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.equals(string);

equalsIgnoreCase(other)

returns a boolean that checks if the given string is equal to the string ignoring case

Parameters

other

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.equalsIgnoreCase(string);

fixed()

returns a copy of the string embedded within an anchor &lt;TT&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.fixed();

fontcolor(color)

returns a copy of the string embedded within an &lt;FONT&gt; tag set, the color param is assigned the the color attribute.

Parameters

color

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.fontcolor(color);

fontsize(size)

returns a copy of the string embedded within an &lt;FONT&gt; tag set, The size param is set to the SIZE attribute

Parameters

size

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.fontsize(size);

fromCharCode(num)

returns a string created by using the specified sequence of Unicode values.

Parameters

Array

num

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

String.fromCharCode(num)
// String.fromCharCode(num1,num2,num3)

includes()

Determines whether one string may be found within another string.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.includes('foo');

indexOf(searchValue, fromIndex)

returns the found index of the given string in string.

Parameters

searchValue

;

fromIndex

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.indexOf(string,startPosition);

italics()

returns a copy of the string embedded within an &lt;I&gt; tag set

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.italics();

lastIndexOf(searchValue, fromIndex)

returns the found index of the given string in string from the end.

Parameters

searchValue

;

fromIndex

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.lastIndexOf(string,startPosition);

link(hrefAttribute)

returns a copy of the string embedded within an &lt;A&gt; tag set.

Parameters

hrefAttribute

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.link(url);

localeCompare(otherString)

Parameters

otherString

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var s = "Have a nice day!";
application.output(s.localeCompare("Hello"));

match(regexp)

returns an array of strings within the current string that matches the regexp.

Parameters

regexp

;

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.match(regexpr);

normalize()

Returns the Unicode Normalization Form of the string. (defaults to "NFC" form)

Returns

A string containing the Unicode Normalization Form of the given string.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

normalize(form)

Returns the Unicode Normalization Form of the string.
form param can be one of "NFC", "NFD", "NFKC", or "NFKD", specifying the Unicode Normalization Form. If omitted or undefined, "NFC" is used.

These values have the following meanings:

"NFC"
Canonical Decomposition, followed by Canonical Composition.
"NFD"
Canonical Decomposition.
"NFKC"
Compatibility Decomposition, followed by Canonical Composition.
"NFKD"
Compatibility Decomposition.

Parameters

form

param can be one of "NFC", "NFD", "NFKC", or "NFKD",

Returns

A string containing the Unicode Normalization Form of the given string.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var string1 = '\u00F1';           // ?
var string2 = '\u006E\u0303';     // ?

string1 = string1.normalize('NFD');
string2 = string2.normalize('NFD');

application.output(string1 === string2); // true
application.output(string1.length);      // 2
application.output(string2.length);      // 2

repeat(count)

Constructs and returns a new string which contains the specified number of copies of the string on which it was called, concatenated together.

Parameters

count

An integer between 0 and +Infinity, indicating the number of times to repeat the string.

Returns

A new string containing the specified number of copies of the given string.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var str = 'abc'.repeat(2); // 'abcabc'

replace(regexp, function)

returns a new string where the matches of the given regexp are replaced by the return value of the function.
The function parameter is the function to be invoked to create the new substring (to put in place of the substring received from parameter #1).

Parameters

regexp

;

Function

function

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

//the callback definition
function replacer(match, p1, p2, p3, offset, string){
		// match is the matched substring
		// p1 is non-digits, p2 digits, and p3 non-alphanumerics
		// offset is the offset of the matched substring within the total string being examined
		// string is the total string being examined
 	return [p1, p2, p3].join(' - ');
}
// using replace method with replacer callback
newString = "abc12345#$*%".replace(/([^\d]*)(\d*)([^\w]*)/, replacer);

replace(regexp, newSubStr)

returns a new string where the matches of the given reg exp are replaced by newSubStr.

Parameters

regexp

;

newSubStr

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.replace(regexp,newSubStr);
//var re = /(\w+)\s(\w+)/;
//var str = "John Smith";
//var newstr = str.replace(re, "$2, $1");
//application.output(newstr);

replace(substr, function)

returns a new string where the first match of the given substr is replaced by the return value of the function.
The function parameter is the function to be invoked to create the new substring (to put in place of the substring received from parameter #1).

Parameters

substr

;

Function

function

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

// the callback definition
function replacer(match){
		return match.toUpperCase()
}
// using replace method with replacer callback
var newString = "abc".replace("a", replacer);

replace(substr, newSubStr)

returns a new string where the first match of the given substr is replaced by newSubStr.

Parameters

substr

;

newSubStr

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.replace(substr,newSubStr);

search(regexp)

returns an index where the first match is found of the regexp

Parameters

regexp

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.search(regexpr);

slice(beginSlice)

returns a substring of the string.

Parameters

beginSlice

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.slice(start,end);

slice(beginSlice, endSlice)

returns a substring of the string.

Parameters

beginSlice

;

endSlice

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.slice(start,end);

small()

returns a copy of the string embedded within an &lt;SMALL&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.small();

split(separator, limit)

returns an array of objects whose elements are segments of the current string.

Parameters

separator

Specifies the string which denotes the points at which each split should occur. If separator is an empty string, str is converted to an array of characters.

limit

Optional integer specifying a limit on the number of splits to be found.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var myString = 'Hello 1 word. Sentence number 2.';
var splits = myString.split(new RegExp(/(\d)/), 2);
application.output(splits); //prints [Hello , 1]

split(separator, limit)

returns an array of objects whose elements are segments of the current string.

Parameters

separator

Specifies the string which denotes the points at which each split should occur. If separator is an empty string, str is converted to an array of characters.

limit

Optional integer specifying a limit on the number of splits to be found.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var myString = 'Hello 1 word. Sentence number 2.';
var splits = myString.split(' ');
application.output(splits);

startsWith(searchString)

Determines whether a string begins with the characters of a specified string, returning true or false as appropriate.

Parameters

searchString

The characters to be searched for at the start of this string.

Returns

true if the given characters are found at the beginning of the string; otherwise, false

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var str1 = 'Cats are the best!';
 application.output(str1.startsWith('Cats'));

startsWith(searchString, position)

Determines whether a string begins with the characters of a specified string, returning true or false as appropriate.

Parameters

searchString

The characters to be searched for at the start of this string.

position

The position in this string at which to begin searching for searchString. Defaults to 0.

Returns

true if the given characters are found at the beginning of the string; otherwise, false

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var str1 = 'Cats are the best!';
 application.output(str1.startsWith('Cats'));

strike()

returns a copy of the string embedded within an &lt;STRIKE&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.strike();

sub()

returns a copy of the string embedded within an &lt;SUB&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.sub();

substr(start)

returns a substring of the string from the start with the number of chars specified.

Parameters

start

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.substr(start, number_of_chars);

substr(start, length)

returns a substring of the string from the start with the number of chars specified.

Parameters

start

;

length

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.substr(start, number_of_chars);

substring(indexA)

Returns a substring of the string from the start index until the end index.

Parameters

indexA

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.substring(start, end);

substring(indexA, indexB)

Returns a substring of the string from the start index until the end index.

Parameters

indexA

;

indexB

;

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.substring(start, end);

sup()

returns a copy of the string embedded within an &lt;SUP&gt; tag set.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.sup();

toLocaleLowerCase()

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var s = "Have a nice day!";
application.output(s.toLocaleLowerCase());

toLocaleUpperCase()

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var s = "Have a nice day!";
application.output(s.toLocaleUpperCase());

toLowerCase()

returns a string with all lowercase letters of the current string.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.toLowerCase();

toUpperCase()

returns a string with all uppercase letters of the current string.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

string.toUpperCase();

trim()

Returns the string stripped of whitespace from both ends.

Returns