String Class Reference

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

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

Detailed Description

BPS Script engine enhancements to the String prototype.

Member Function Documentation

lpad()

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.

ltrim()

String String::ltrim

(

)

Left trimmed string.

Returns

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

rpad()

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.

rtrim()

String String::rtrim

(

)

Right trimmed string.

Returns

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

trim()

String String::trim

(

)

Trimmed string.

Returns

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

---

The documentation for this class was generated from the following file:

• Engine.js