String Class Reference

BPS Script engine enhancements to the String prototype. More...

List of all members.

Public Member Functions
String	lpad (Number aSize, String aPadText= ' ')
	Return a copy of the string left padded up to the desired total string size.
String	ltrim ()
	Left trimmed string.
String	rpad (Number aSize, String aPadText= ' ')
	Return a copy of the string right padded up to the desired total string size.
String	rtrim ()
	Right trimmed string.
String	trim ()
	Trimmed string.

---

Detailed Description

BPS Script engine enhancements to the String prototype.

---

Member Function Documentation

String String::lpad	(	Number	aSize,
		String	aPadText = ' '
	)

Return a copy of the string left padded up to the desired total string size.

Parameters:

[in]	aSize	Minimum size to pad the string to.
[in]	aPadText	The text used for padding, normally a single character.

Returns:

The padded string.

String String::ltrim

(

)

Left trimmed string.

Returns:

Copy of the string where whitespace is removed from the begin.

String String::rpad	(	Number	aSize,
		String	aPadText = ' '
	)

Return a copy of the string right padded up to the desired total string size.

Parameters:

[in]	aSize	Minimum size to pad the string to.
[in]	aPadText	The text used for padding, normally a single character.

Returns:

The padded string.

String String::rtrim

(

)

Right trimmed string.

Returns:

Copy of the string where whitespace is removed from the end.

String String::trim

(

)

Trimmed string.

Returns:

Copy of the string where whitespace is removed from begin and end.