Page History

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
String

...

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturn the byte array representation of the Base64 valueReturn the String representation of the Base64 valueReturn the Base64 value representation of the byteArrayReturn the string conversion of the byteArrayFormat a date object to a text representation.

...

Table Cell (td)
String

...

Format a date object to a text representation using the format and timezone given.

Format a date object to a text representation.

Format a date object to a text representation using the format, timezone, language and country given.

Returns a string containing the character for the unicode number.

...

Table Cell (td)
Boolean

...

Returns true if the (related)foundset exists and has records.

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

Returns true if the (related)foundset exists and has records.

...

Returns true when Monday is the first day of the week for your current locale setting.

...

Table Cell (td)
String

...

Table Cell (td)
String

...

Format a number to have a defined fraction.

...

Format a number to specification.

...

Table Cell (td)
Date

...

Parse a string to a date object.

...

Table Cell (td)
String

...

Returns the escaped markup text (HTML/XML).

...

Table Cell (td)
String

...

Returns the escaped markup text (HTML/XML).

...

Table Cell (td)
String

...

Returns the escaped markup text (HTML/XML).

...

Table Cell (td)
String

...

Formats a string according to format specifiers and arguments

...

Table Cell (td)
String

...

.

Format a string using mask.

Replaces a portion of a string with replacement text from a specified index.

...

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
stringInitCap(text) Returns all words starting with capital chars.

...

Table Cell (td)
String

...

Table Cell (td)
String

...

Returns all words starting with capital chars.

Returns a string with the requested number of characters, starting from the left.

...

Table Cell (td)
String

...

Returns the number of words, starting from the left.

...

Table Cell (td)
String

...

Returns the md5 hash (encoded as base16) for specified text.

...

Returns the md5 hash (encoded as base64) for specified text

...

Table Cell (td)
String

...

Table Cell (td)
String

...

.

Returns a substring from the original string.

...

Returns

...

the

...

Table Cell (td)
String

...

PBKDF2 hash for specified text.

...

Table Cell (td)
String

...

Returns the PBKDF2 hash for specified text.

...

Table Cell (td)
Number

...

Table Cell (td)
Number

...

Returns the number of times searchString appears in textString.

...

Returns the position of the string to search for, from a certain start position and occurrence.

...

Table Cell (td)
String

...

Replaces a portion of a string with replacement text.

...

Table Cell (td)
String

...

Returns the text with %%tags%% replaced, based on provided record or foundset or form.

...

Table Cell (td)
String

...

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
stringRightWords(text, numberof_words) Returns the number of words, starting from the right.

...

Table Cell (td)
Number

...

Returns a string with the requested number of characters, starting from the right.

...

Returns the number of words, starting from the right.

Return the Base64 representation of the string

Return the byte array representation of the string

Filters characters out of from a string and leaves digits, returns the number.

...

Table Cell (td)
Number

...

Table Cell (td)
String

...

Filters characters out of from a string and leaves digits, returns the number.

...

Returns the string without leading or trailing spaces.

...

Table Cell (td)
Number

...

Returns the number of words in the text string.

...

Table Cell (td)
Date

...

Table Cell (td)
Boolean

...

Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).

...

Validates the given password against the given hash.

...

function

...

servoy sDetail

...

padding	0px
width	100%

...

class	lastDetailRow

...

id	stringInitCap-String

Table Row (tr)

id	name

Table Cell (td)
stringInitCap

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringInitCap

Span
(text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all words starting with capital chars.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the changed text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'This Is A Test'
var retval = utils.stringInitCap('This is A test');

...

class	lastDetailRow

...

id	stringLeft-String_Number

Table Row (tr)

id	name

Table Cell (td)
stringLeft

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringLeft

Span
(text, i_size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a string with the requested number of characters, starting from the left.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{Number} i_size - the size of the text to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the result text string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'this i'
var retval = utils.stringLeft('this is a test',6);

...

class	lastDetailRow

...

id	stringLeftWords-String_Number

Table Row (tr)

id	name

Table Cell (td)
stringLeftWords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringLeftWords

Span
(text, numberof_words)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the number of words, starting from the left.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - to process
{Number} numberof_words - to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the string with number of words form the left

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'this is a'
var retval = utils.stringLeftWords('this is a test',3);

...

class	lastDetailRow

...

id	stringMD5HashBase16-String

Table Row (tr)

id	name

Table Cell (td)
stringMD5HashBase16

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringMD5HashBase16

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the md5 hash (encoded as base16) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting hashString

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var hashed_password = utils.stringMD5HashBase16(user_password)

...

class	lastDetailRow

...

id	stringMD5HashBase64-String

Table Row (tr)

id	name

Table Cell (td)
stringMD5HashBase64

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringMD5HashBase64

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the md5 hash (encoded as base64) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting hashString

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var hashed_password = utils.stringMD5HashBase64(user_password)

...

class	lastDetailRow

...

id	stringMiddle-String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
stringMiddle

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringMiddle

Span
(text, i_start, i_size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a substring from the original string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{Number} i_start - the start index to work from
{Number} i_size - the size of the text to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the result text string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'his'
var retval = utils.stringMiddle('this is a test',2,3);

...

class	lastDetailRow

...

id	stringMiddleWords-String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
stringMiddleWords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringMiddleWords

Span
(text, i_start, numberof_words)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a substring from the original string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - to process
{Number} i_start - start word index
{Number} numberof_words - the word count to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the string with number of words form the left and

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'is a'
var retval = utils.stringMiddleWords('this is a test',2,2);

...

class	lastDetailRow

...

id	stringPBKDF2Hash-String

Table Row (tr)

id	name

Table Cell (td)
stringPBKDF2Hash

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringPBKDF2Hash

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.
It uses a default of 2000 iterations.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting hashString

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var hashed_password = utils.stringPBKDF2Hash(user_password)

...

class	lastDetailRow

...

id	stringPBKDF2Hash-String_Number

Table Row (tr)

id	name

Table Cell (td)
stringPBKDF2Hash

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringPBKDF2Hash

Span
(textString, iterations)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process
{Number} iterations - how many hash iterations should be done, minimum should be 1000 or higher.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting hashString

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var hashed_password = utils.stringPBKDF2Hash(user_password,5000)

...

class	lastDetailRow

...

id	stringPatternCount-String_String

Table Row (tr)

id	name

Table Cell (td)
stringPatternCount

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

stringPatternCount

Span
(text, toSearchFor)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the number of times searchString appears in textString.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{String} toSearchFor - the string to search for

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the occurrenceCount that the search string is found in the text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 2 as count
var count = utils.stringPatternCount('this is a test','is');

...

class	lastDetailRow

...

id	stringPosition-String_String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
stringPosition

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

stringPosition

Span
(textString, toSearchFor, i_start, i_occurrence)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the position of the string to search for, from a certain start position and occurrence.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process
{String} toSearchFor - the string to search
{Number} i_start - the start index to search from
{Number} i_occurrence - the occurrence

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the position

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 4 as position
var pos = utils.stringPosition('This is a test','s',1,1)

...

class	lastDetailRow

...

id	stringReplace-String_String_String

Table Row (tr)

id	name

Table Cell (td)
stringReplace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringReplace

Span
(text, search_text, replacement_text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Replaces a portion of a string with replacement text.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{String} search_text - the string to search
{String} replacement_text - the replacement text

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the changed text string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'these are cow 1 and cow 2.'
var retval = utils.stringReplace('these are test 1 and test 2.','test','cow');

...

class	lastDetailRow

...

id	stringReplaceTags-String_Object

Table Row (tr)

id	name

Table Cell (td)
stringReplaceTags

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringReplaceTags

Span
(text, scriptable)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the text with %%tags%% replaced, based on provided record or foundset or form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text tags to work with
{Object} scriptable - the javascript object or foundset,record,form to be used to fill in the tags

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the text with replaced tags

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Next line places a string in variable x, whereby the tag(%%TAG%%) is filled with the value of the database column 'company_name' of the selected record.
var x = utils.stringReplaceTags("The companyName of the selected record is %%company_name%% ", foundset)
//var otherExample = utils.stringReplaceTags("The amount of the related order line %%amount%% ", order_to_orderdetails);
//var recordExample = utils.stringReplaceTags("The amount of the related order line %%amount%% ", order_to_orderdetails.getRecord(i);
//Next line places a string in variable y, whereby the tag(%%TAG%%) is filled with the value of the form variable 'x' of the form named 'main'.
//var y = utils.stringReplaceTags("The value of form variable is %%x%% ", forms.main);
//The next sample shows the use of a javascript object
//var obj = new Object();//create a javascript object
//obj['x'] = 'test';//assign an named value
//var y = utils.stringReplaceTags("The value of object variable is %%x%% ", obj);//use the named value in a tag

...

class	lastDetailRow

...

id	stringRight-String_Number

Table Row (tr)

id	name

Table Cell (td)
stringRight

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringRight

Span
(text, i_size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a string with the requested number of characters, starting from the right.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{Number} i_size - the size of the text to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the result text string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'a test'
var retval = utils.stringLeft('this is a test',6);

...

class	lastDetailRow

...

id	stringRightWords-String_Number

Table Row (tr)

id	name

Table Cell (td)
stringRightWords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringRightWords

Span
(text, numberof_words)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the number of words, starting from the right.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - to process
{Number} numberof_words - to return

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the string with number of words form the right

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'is a test'
var retval = utils.stringRightWords('this is a test',3);

...

class	lastDetailRow

...

id	stringToNumber-String

Table Row (tr)

id	name

Table Cell (td)
stringToNumber

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

stringToNumber

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Filters characters out of from a string and leaves digits, returns the number. Uses locale decimal separator.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the resulting number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 65567
var retval = utils.stringToNumber('fg65gf567');

...

class	lastDetailRow

...

id	stringToNumber-String_String

Table Row (tr)

id	name

Table Cell (td)
stringToNumber

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

stringToNumber

Span
(textString, decimalSeparator)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Filters characters out of from a string and leaves digits, returns the number. Decimal separator is specified as parameter.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process
{String} decimalSeparator - decimal separator

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the resulting number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 65.567
var retval = utils.stringToNumber('fg65gf.567','.');

...

class	lastDetailRow

...

id	stringTrim-String

Table Row (tr)

id	name

Table Cell (td)
stringTrim

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringTrim

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the string without leading or trailing spaces.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting trimmed string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'text'
var retval = utils.stringTrim('   text   ');

...

class	lastDetailRow

...

id	stringWordCount-String

Table Row (tr)

id	name

Table Cell (td)
stringWordCount

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

stringWordCount

Span
(text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the number of words in the text string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the word count

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns '4' as result
var retval = utils.stringWordCount('this is a test');

...

class	lastDetailRow

...

id	timestampToDate-Date

Table Row (tr)

id	name

Table Cell (td)
timestampToDate

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Date

Span

style	font-weight: bold;

timestampToDate

Span
(date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Date} date - object to be stripped from its time elements

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Date - the stripped date object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var date = utils.timestampToDate(application.getTimeStamp());

...

class	lastDetailRow

...

id	validatePBKDF2Hash-String_String

Table Row (tr)

id	name

Table Cell (td)
validatePBKDF2Hash

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

validatePBKDF2Hash

Span
(password, hash)

...

id	des

...

class	sIndent

Validates the given password against the given hash. The hash should be generated by one of the stringPBKDF2Hash(password [,iteration]) functions. If hash is null or empty string the method will return false.

...

2100%

height:30px

...

Table Head (th)

colspan	1

Method Details

...

id	dateFormat-Date_String

Table Row (tr)

id	name

Table Cell (td)
dateFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

dateFormat

Span
(date, format)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Format a date object to a text representation.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Date} date - the date
{String} format - the format to output

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the date as text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var formattedDateString = utils.dateFormat(dateobject,'EEE, d MMM yyyy HH:mm:ss');

...

class	lastDetailRow

...

id	getUnicodeCharacter-Number

Table Row (tr)

id	name

Table Cell (td)
getUnicodeCharacter

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getUnicodeCharacter

Span
(unicodeCharacterNumber)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a string containing the character for the unicode number.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} unicodeCharacterNumber - the number indicating the unicode character

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a string containing the unicode character

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns a big dot
var dot = utils.getUnicodeCharacter(9679);

...

class	lastDetailRow

...

id	hasRecords-JSFoundSet

Table Row (tr)

id	name

Table Cell (td)
hasRecords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasRecords

Span
(foundset)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFoundSet} foundset - the foundset to be tested

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if exists

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//test the orders_to_orderitems foundset
if (elements.customer_id.hasRecords(orders_to_orderitems))
{
	//do work on relatedFoundSet
}
//test the orders_to_orderitems.orderitems_to_products foundset to be reached from the current record
//if (elements.customer_id.hasRecords(foundset.getSelectedRecord(),'orders_to_orderitems.orderitems_to_products'))
//{
//	//do work on deeper relatedFoundSet
//}

...

class	lastDetailRow

...

id	hasRecords-JSRecord_String

Table Row (tr)

id	name

Table Cell (td)
hasRecords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasRecords

Span
(record, relationString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSRecord} record - A JSRecord to test.
{String} relationString - The relation name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if the foundset/relation has records.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//test the orders_to_orderitems foundset
if (elements.customer_id.hasRecords(orders_to_orderitems))
{
	//do work on relatedFoundSet
}
//test the orders_to_orderitems.orderitems_to_products foundset to be reached from the current record
//if (elements.customer_id.hasRecords(foundset.getSelectedRecord(),'orders_to_orderitems.orderitems_to_products'))
//{
//	//do work on deeper relatedFoundSet
//}

...

class	lastDetailRow

...

id	isMondayFirstDayOfWeek

Table Row (tr)

id	name

Table Cell (td)
isMondayFirstDayOfWeek

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isMondayFirstDayOfWeek

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true when Monday is the first day of the week for your current locale setting.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if Monday is first day of the week in current locale

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

if(utils.isMondayFirstDayOfWeek())
{
	//a date calculation
}

...

class	lastDetailRow

...

id	numberFormat-Number_Number

Table Row (tr)

id	name

Table Cell (td)
numberFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

numberFormat

Span
(number, digits)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Format a number to have a defined fraction.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} number - the number to format
{Number} digits - nr of digits

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting number in text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var textalNumber = utils.numberFormat(16.749, 2); //returns 16.75

...

class	lastDetailRow

...

id	numberFormat-Number_String

Table Row (tr)

id	name

Table Cell (td)
numberFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

numberFormat

Span
(number, format)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Format a number to specification.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} number - the number to format
{String} format - the format

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the resulting number in text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var textalNumber2 = utils.numberFormat(100006.749, '#,###.00'); //returns 100,006.75

...

class	lastDetailRow

...

id	parseDate-String_String

Table Row (tr)

id	name

Table Cell (td)
parseDate

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Date

Span

style	font-weight: bold;

parseDate

Span
(date, format)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Parse a string to a date object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} date - the date as text
{String} format - the format to parse the to date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Date - the date as date object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var parsedDate = utils.parseDate(datestring,'EEE, d MMM yyyy HH:mm:ss');

...

class	lastDetailRow

...

id	stringEscapeMarkup-String

Table Row (tr)

id	name

Table Cell (td)
stringEscapeMarkup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringEscapeMarkup

Span
(textString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the escaped markup text (HTML/XML).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the escaped text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')

...

class	lastDetailRow

...

id	stringEscapeMarkup-String_Boolean

Table Row (tr)

id	name

Table Cell (td)
stringEscapeMarkup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringEscapeMarkup

Span
(textString, escapeSpaces)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the escaped markup text (HTML/XML).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process
{Boolean} escapeSpaces - indicating to escape spaces

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the escaped text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')

...

class	lastDetailRow

...

id	stringEscapeMarkup-String_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
stringEscapeMarkup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringEscapeMarkup

Span
(textString, escapeSpaces, convertToHtmlUnicodeEscapes)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the escaped markup text (HTML/XML).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} textString - the text to process
{Boolean} escapeSpaces - indicating to escape spaces
{Boolean} convertToHtmlUnicodeEscapes - indicating to use unicode escapes

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the escaped text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')

...

class	lastDetailRow

...

id	stringFormat-String_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
stringFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringFormat

Span
(text_to_format, parameters)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Formats a string according to format specifiers and arguments.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text_to_format - the text to format
{Object[]} parameters - the array with parameters

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the formatted text

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// the  format specifier has the syntax: %[argument_index$][flags][width][.precision]conversion
// argument index is 1$, 2$ ...
// flags is a set of characters that modify the output format
// typical values: '+'(The result will always include a sign), ','(The result will include locale-specific grouping separators)
// width is a non-negative decimal integer indicating the minimum number of characters to be written to the output
// precision is a non-negative decimal integer usually used to restrict the number of characters
// conversion is a character indicating how the argument should be formatted
// typical conversion values: b(boolean), s(string), c(character), d(decimal integer), f(floating number), t(prefix for date and time)
// Date/Time Conversions (used after 't' prefix):
		// 'H' 	Hour of the day for the 24-hour clock, formatted as two digits with a leading zero as necessary i.e. 00 - 23.
		// 'I' 	Hour for the 12-hour clock, formatted as two digits with a leading zero as necessary, i.e. 01 - 12.
		// 'k' 	Hour of the day for the 24-hour clock, i.e. 0 - 23.
		// 'l' 	Hour for the 12-hour clock, i.e. 1 - 12.
		// 'M' 	Minute within the hour formatted as two digits with a leading zero as necessary, i.e. 00 - 59.
		// 'S' 	Seconds within the minute, formatted as two digits with a leading zero as necessary, i.e. 00 - 60 ("60" is a special value required to support leap seconds).
		// 'L' 	Millisecond within the second formatted as three digits with leading zeros as necessary, i.e. 000 - 999.
		// 'p' 	Locale-specific morning or afternoon marker in lower case, e.g."am" or "pm". Use of the conversion prefix 'T' forces this output to upper case.
		// 'z' 	RFC 822 style numeric time zone offset from GMT, e.g. -0800.
		// 'Z' 	A string representing the abbreviation for the time zone.
		// 'B' 	Locale-specific full month name, e.g. "January", "February".
		// 'b' 	Locale-specific abbreviated month name, e.g. "Jan", "Feb".
		// 'h' 	Same as 'b'.
		// 'A' 	Locale-specific full name of the day of the week, e.g. "Sunday", "Monday"
		// 'a' 	Locale-specific short name of the day of the week, e.g. "Sun", "Mon"
		// 'C' 	Four-digit year divided by 100, formatted as two digits with leading zero as necessary, i.e. 00 - 99
		// 'Y' 	Year, formatted as at least four digits with leading zeros as necessary, e.g. 0092 equals 92 CE for the Gregorian calendar.
		// 'y' 	Last two digits of the year, formatted with leading zeros as necessary, i.e. 00 - 99.
		// 'j' 	Day of year, formatted as three digits with leading zeros as necessary, e.g. 001 - 366 for the Gregorian calendar.
		// 'm' 	Month, formatted as two digits with leading zeros as necessary, i.e. 01 - 13.
		// 'd' 	Day of month, formatted as two digits with leading zeros as necessary, i.e. 01 - 31
		// 'e' 	Day of month, formatted as two digits, i.e. 1 - 31.

		// common compositions for date/time conversion
		// 'R' 	Time formatted for the 24-hour clock as "%tH:%tM"
		// 'T' 	Time formatted for the 24-hour clock as "%tH:%tM:%tS".
		// 'r' 	Time formatted for the 12-hour clock as "%tI:%tM:%tS %Tp". The location of the morning or afternoon marker ('%Tp') may be locale-dependent.
		// 'D' 	Date formatted as "%tm/%td/%ty".
		// 'F' 	ISO 8601 complete date formatted as "%tY-%tm-%td".
		// 'c' 	Date and time formatted as "%ta %tb %td %tT %tZ %tY", e.g. "Sun Jul 20 16:17:00 EDT 1969".

utils.stringFormat('%s Birthday: %2$tm %2$te,%2$tY',new Array('My',new Date(2009,0,1))) // returns My Birthday: 01 1,2009
utils.stringFormat('The time is: %1$tH:%1$tM:%1$tS',new Array(new Date(2009,0,1,12,0,0))) // returns The time is: 12:00:00
utils.stringFormat('My %s: %2$.0f, my float: %2$.2f',new Array('integer',10)) // returns My integer: 10, my float: 10.00
utils.stringFormat('Today is: %1$tc',new Array(new Date())) // returns current date/time as:  Today is: Fri Feb 20 14:15:54 EET 2009
utils.stringFormat('Today is: %tF',new Array(new Date())) // returns current date as: Today is: 2009-02-20

...

class	lastDetailRow

...

id	stringIndexReplace-String_Number_Number_String

Table Row (tr)

id	name

Table Cell (td)
stringIndexReplace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

stringIndexReplace

Span
(text, i_start, i_size, replacement_text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Replaces a portion of a string with replacement text from a specified index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - the text to process
{Number} i_start - the start index to work from
{Number} i_size - the size of the text to replace
{String} replacement_text - the replacement text

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the changed text string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//returns 'this was a test'
var retval = utils.stringIndexReplace('this is a test',6,2,'was');

2

Methods Details

base64ToBytes

name

base64ToBytes(base64String:)

des

sIndent

Return the byte array representation of the Base64 value

prs

Parameters

sIndent

base64String:

the Base64 encoded string to convert to byte array

ret

Returns

sIndent

byteArray representation of the base64 string using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

base64ToString

name

base64ToString(base64String:)

des

sIndent

Return the String representation of the Base64 value

prs

Parameters

sIndent

base64String:

the Base64 value to convert to String

ret

Returns

sIndent

String decoded representation of the Base64 value using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

bytesToBase64

name

bytesToBase64(byteArray:)

des

sIndent

Return the Base64 value representation of the byteArray

prs

Parameters

sIndent

byteArray:

the byte array to convert to Base64 value

ret

Returns

sIndent

Base64 representation of the byte array using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

bytesToHex

name

bytesToHex(bytearray)

des

sIndent

prs

Parameters

sIndent

bytearray

the byte array to convert to hex encoded string

ret

Returns

sIndent

returns hex encoded string from bytearray

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

bytesToString

name

bytesToString(byteArray:)

des

sIndent

Return the string conversion of the byteArray

prs

Parameters

sIndent

byteArray:

the byte array to convert to

ret

Returns

sIndent

string representation of the byte array using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dateFormat

name

dateFormat(date, format)

des

sIndent

Format a date object to a text representation.
This will format with the system timezone for the webclient
For NGClient it will use the timezone of the client, the same goes for the Smartclient (but that is the system timezone)
see #dateFormat(Date,String,String) for using the actual clients timezone.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'.
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)

prs

Parameters

sIndent

date

the date

format

the format to output

ret

Returns

sIndent

the date as text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

dateFormat

name

dateFormat(date, format, timezone)

des

sIndent

Format a date object to a text representation using the format and timezone given.
If the timezone is not given the timezone of the client itself will be used.
see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)

prs

Parameters

sIndent

date

the date

format

the format to output

timezone

The timezone string to use to parse the date (like GMT+3), if null then the timezone of the current client is used.

ret

Returns

sIndent

the date as text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dateFormat

name

dateFormat(date, format, language, country)

des

sIndent

Format a date object to a text representation.
This will format with the system timezone for the webclient
With language and/or country the locale will be created.
For NGClient it will use the timezone of the client, the same goes for the Smartclient (but that is the system timezone)
see #dateFormat(Date,String,String) for using the actual clients timezone.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'.
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)

prs

Parameters

sIndent

date

the date

format

the format to output

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the date as text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dateFormat

name

dateFormat(date, format, timezone, language, country)

des

sIndent

Format a date object to a text representation using the format, timezone, language and country given.
With the language and country given, the locale will be created.
If the timezone is not given the timezone of the client itself will be used.
see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)

prs

Parameters

sIndent

date

the date

format

the format to output

timezone

the timezone to use the format, if null then current client timezone is used.

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the date as text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getUnicodeCharacter

name

getUnicodeCharacter(unicodeCharacterNumber)

des

sIndent

Returns a string containing the character for the unicode number.

prs

Parameters

sIndent

unicodeCharacterNumber

the number indicating the unicode character

ret

Returns

sIndent

a string containing the unicode character

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasRecords

name

hasRecords(foundset)

des

sIndent

Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once

prs

Parameters

sIndent

foundset

the foundset to be tested

ret

Returns

sIndent

true if exists

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

hasRecords

name

hasRecords(record, relationString)

des

sIndent

Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once

prs

Parameters

sIndent

record

A JSRecord to test.

relationString

The relation name.

ret

Returns

sIndent

true if the foundset/relation has records.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

hexToBytes

name

hexToBytes(hex)

des

sIndent

prs

Parameters

sIndent

hex

hex encoded string to be decoded into a byte array.

ret

Returns

sIndent

a byte array from hex encoded string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hexToString

name

hexToString(hex)

des

sIndent

prs

Parameters

sIndent

hex

;

ret

Returns

sIndent

returns decoded string from hex

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isMondayFirstDayOfWeek

name

isMondayFirstDayOfWeek()

des

sIndent

Returns true when Monday is the first day of the week for your current locale setting.

ret

Returns

sIndent

true if Monday is first day of the week in current locale

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

numberFormat

name

numberFormat(number, digits)

des

sIndent

Format a number to have a defined fraction.

prs

Parameters

sIndent

number

the number to format

digits

nr of digits

ret

Returns

sIndent

the resulting number in text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

numberFormat

name

numberFormat(number, digits, language, country)

des

sIndent

Format a number to have a defined fraction.

prs

Parameters

sIndent

number

the number to format

digits

nr of digits

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the resulting number in text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

numberFormat

name

numberFormat(number, format)

des

sIndent

Format a number to specification.

prs

Parameters

sIndent

number

the number to format

format

the format

ret

Returns

sIndent

the resulting number in text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

numberFormat

name

numberFormat(number, format, language, country)

des

sIndent

Format a number to specification.

prs

Parameters

sIndent

number

the number to format

format

the format

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the resulting number in text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

parseDate

name

parseDate(date, format)

des

sIndent

Parse a string to a date object. This parses the date using the TimeZone of the server
Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'

prs

Parameters

sIndent

date

the date as text

format

the format to parse the date

ret

Returns

sIndent

the date as date object

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

parseDate

name

parseDate(date, format, timezone)

des

sIndent

Parse a string to a date object. Using the timezone that is given, if null then it formats it with the clients timezone.

see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'

prs

Parameters

sIndent

date

the date as text

format

the format to parse the date

timezone

The timezone string to use to parse the date (like GMT+3)

ret

Returns

sIndent

the date as date object

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

parseDate

name

parseDate(date, format, language, country)

des

sIndent

Parse a string to a date object. Using language and country that are given,
if null then it formats it with the locale of the client

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'

prs

Parameters

sIndent

date

the date as text

format

the format to parse the date

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the date as date object

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

parseDate

name

parseDate(date, format, timezone, language, country)

des

sIndent

Parse a string to a date object. Using the timezone, language and country that are given,
if null then it formats it with the timezone and locale of the client

see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'

prs

Parameters

sIndent

date

the date as text

format

the format to parse the date

timezone

The timezone string to use to parse the date (like GMT+3)

language

language used to create locale

country

country used along side language to create the locale

ret

Returns

sIndent

the date as date object

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringEscapeMarkup

name

stringEscapeMarkup(textString)

des

sIndent

Returns the escaped markup text (HTML/XML).

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the escaped text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringEscapeMarkup

name

stringEscapeMarkup(textString, escapeSpaces)

des

sIndent

Returns the escaped markup text (HTML/XML).

prs

Parameters

sIndent

textString

the text to process

escapeSpaces

indicating to escape spaces

ret

Returns

sIndent

the escaped text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringEscapeMarkup

name

stringEscapeMarkup(textString, escapeSpaces, convertToHtmlUnicodeEscapes)

des

sIndent

Returns the escaped markup text (HTML/XML).

prs

Parameters

sIndent

textString

the text to process

escapeSpaces

indicating to escape spaces

convertToHtmlUnicodeEscapes

indicating to use unicode escapes

ret

Returns

sIndent

the escaped text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringFormat

name

stringFormat(text_to_format, parameters)

des

sIndent

Formats a string according to format specifiers and arguments.

prs

Parameters

sIndent

text_to_format

the text to format

parameters

the array with parameters

ret

Returns

sIndent

the formatted text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringFormat

name

stringFormat(text, format)

des

sIndent

Format a string using mask.

prs

Parameters

sIndent

text

the string to format

format

the format

ret

Returns

sIndent

the resulting text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringIndexReplace

name

stringIndexReplace(text, i_start, i_size, replacement_text)

des

sIndent

Replaces a portion of a string with replacement text from a specified index.

prs

Parameters

sIndent

text

the text to process

i_start

the start index to work from

i_size

the size of the text to replace

replacement_text

the replacement text

ret

Returns

sIndent

the changed text string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringInitCap

name

stringInitCap(text)

des

sIndent

Returns all words starting with capital chars.

prs

Parameters

sIndent

text

the text to process

ret

Returns

sIndent

the changed text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringLeft

name

stringLeft(text, i_size)

des

sIndent

Returns a string with the requested number of characters, starting from the left.

prs

Parameters

sIndent

text

the text to process

i_size

the size of the text to return

ret

Returns

sIndent

the result text string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringLeftWords

name

stringLeftWords(text, numberof_words)

des

sIndent

Returns the number of words, starting from the left.

prs

Parameters

sIndent

text

to process

numberof_words

to return

ret

Returns

sIndent

the string with number of words form the left

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringMD5HashBase16

name

stringMD5HashBase16(textString)

des

sIndent

Returns the md5 hash (encoded as base16) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the resulting hashString

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringMD5HashBase64

name

stringMD5HashBase64(textString)

des

sIndent

Returns the md5 hash (encoded as base64) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the resulting hashString

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringMiddle

name

stringMiddle(text, i_start, i_size)

des

sIndent

Returns a substring from the original string.

prs

Parameters

sIndent

text

the text to process

i_start

the start index to work from

i_size

the size of the text to return

ret

Returns

sIndent

the result text string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringMiddleWords

name

stringMiddleWords(text, i_start, numberof_words)

des

sIndent

Returns a substring from the original string.

prs

Parameters

sIndent

text

to process

i_start

start word index

numberof_words

the word count to return

ret

Returns

sIndent

the string with number of words form the left and

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringPBKDF2Hash

name

stringPBKDF2Hash(textString)

des

sIndent

Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.
It uses a default of 9999 iterations. The string that is returned can only be used in the utils.validatePBKDF2Hash(password,thisReturnValue)
to check if this hash is a result of that password.
This will always be false: utils.stringPBKDF2Hash("test") == utils.stringPBKDF2Hash("test"). Because for the same string in multiply calls it will not generate the same hash.
So you can only check it like this: utils.validatePBKDF2Hash("test",utils.stringPBKDF2Hash("test"))

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the resulting hashString

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringPBKDF2Hash

name

stringPBKDF2Hash(textString, iterations)

des

sIndent

Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2

prs

Parameters

sIndent

textString

the text to process

iterations

how many hash iterations should be done, minimum should be 1000 or higher.

ret

Returns

sIndent

the resulting hashString

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringPatternCount

name

stringPatternCount(text, toSearchFor)

des

sIndent

Returns the number of times searchString appears in textString.

prs

Parameters

sIndent

text

the text to process

toSearchFor

the string to search for

ret

Returns

sIndent

the occurrenceCount that the search string is found in the text

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringPosition

name

stringPosition(textString, toSearchFor, i_start, i_occurrence)

des

sIndent

Returns the position of the string to search for, from a certain start position and occurrence.

prs

Parameters

sIndent

textString

the text to process

toSearchFor

the string to search

i_start

the start index to search from

i_occurrence

the occurrence

ret

Returns

sIndent

the position

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringReplace

name

stringReplace(text, search_text, replacement_text)

des

sIndent

Replaces a portion of a string with replacement text.

prs

Parameters

sIndent

text

the text to process

search_text

the string to search

replacement_text

the replacement text

ret

Returns

sIndent

the changed text string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringReplaceTags

name

stringReplaceTags(text, scriptable)

des

sIndent

Returns the text with %%tags%% replaced, based on provided record or foundset or form.

prs

Parameters

sIndent

text

the text tags to work with

scriptable

the javascript object or foundset,record,form to be used to fill in the tags

ret

Returns

sIndent

the text with replaced tags

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringRight

name

stringRight(text, i_size)

des

sIndent

Returns a string with the requested number of characters, starting from the right.

prs

Parameters

sIndent

text

the text to process

i_size

the size of the text to return

ret

Returns

sIndent

the result text string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringRightWords

name

stringRightWords(text, numberof_words)

des

sIndent

Returns the number of words, starting from the right.

prs

Parameters

sIndent

text

to process

numberof_words

to return

ret

Returns

sIndent

the string with number of words form the right

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringToBase64

name

stringToBase64(string:)

des

sIndent

Return the Base64 representation of the string

prs

Parameters

sIndent

string:

the string to convert to Base64

ret

Returns

sIndent

Base64 encoded representation of the string using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringToBytes

name

stringToBytes(string:)

des

sIndent

Return the byte array representation of the string

prs

Parameters

sIndent

string:

the string to convert to bytes

ret

Returns

sIndent

byte array representation of the string using UTF-8 charset for conversion

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringToHex

name

stringToHex(string)

des

sIndent

prs

Parameters

sIndent

string

String to be encoded into hex

ret

Returns

sIndent

returns hex encoded string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringToNumber

name

stringToNumber(textString)

des

sIndent

Filters characters out of from a string and leaves digits, returns the number. Uses locale decimal separator.

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the resulting number

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringToNumber

name

stringToNumber(textString, decimalSeparator)

des

sIndent

Filters characters out of from a string and leaves digits, returns the number. Decimal separator is specified as parameter.

prs

Parameters

sIndent

textString

the text to process

decimalSeparator

decimal separator

ret

Returns

sIndent

the resulting number

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringTrim

name

stringTrim(textString)

des

sIndent

Returns the string without leading or trailing spaces.

prs

Parameters

sIndent

textString

the text to process

ret

Returns

sIndent

the resulting trimmed string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

stringWordCount

name

stringWordCount(text)

des

sIndent

Returns the number of words in the text string.

prs

Parameters

sIndent

text

the text to process

ret

Returns

sIndent

the word count

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

timestampToDate

name

timestampToDate(date)

des

sIndent

Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).

prs

Parameters

sIndent

date

object to be stripped from its time elements

ret

Returns

sIndent

the stripped date object

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

validatePBKDF2Hash

name

validatePBKDF2Hash(password, hash)

des

sIndent

Validates the given password against the given hash. The hash should be generated by one of the stringPBKDF2Hash(password [,iteration]) functions. If hash is null or empty string the method will return false.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2

...

prs

...

Parameters

...

sIndent

...

password

...

the password to test against

...

hash

...

the hash the password needs to validate to.

...

ret

...

Returns

...

sIndent

...

true if his hash is valid for that password

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

Sample

...

class	sIndent

...

Code Block

language	javascript

if (utils.validatePBKDF2Hash(user_password, hashFromDb)) {
   // logged in
}

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 22

New Version Current

Key

stringInitCap

stringLeft

stringLeftWords

stringMD5HashBase16

stringMD5HashBase64

stringMiddle

stringMiddleWords

stringPBKDF2Hash

stringPBKDF2Hash

stringPatternCount

stringPosition

stringReplace

stringReplaceTags

stringRight

stringRightWords

stringToNumber

stringToNumber

stringTrim

stringWordCount

timestampToDate

validatePBKDF2Hash

dateFormat

getUnicodeCharacter

hasRecords

hasRecords

isMondayFirstDayOfWeek

numberFormat

numberFormat

parseDate

stringEscapeMarkup

stringEscapeMarkup

stringEscapeMarkup

stringFormat

stringIndexReplace

base64ToBytes(base64String:)

base64ToString(base64String:)

bytesToBase64(byteArray:)

bytesToHex(bytearray)

bytesToString(byteArray:)

dateFormat(date, format)

dateFormat(date, format, timezone)

dateFormat(date, format, language, country)

dateFormat(date, format, timezone, language, country)

getUnicodeCharacter(unicodeCharacterNumber)

hasRecords(foundset)

hasRecords(record, relationString)

hexToBytes(hex)

hexToString(hex)

isMondayFirstDayOfWeek()

numberFormat(number, digits)

numberFormat(number, digits, language, country)

numberFormat(number, format)

numberFormat(number, format, language, country)

parseDate(date, format)

parseDate(date, format, timezone)

parseDate(date, format, language, country)

parseDate(date, format, timezone, language, country)

stringEscapeMarkup(textString)

stringEscapeMarkup(textString, escapeSpaces)

stringEscapeMarkup(textString, escapeSpaces, convertToHtmlUnicodeEscapes)

stringFormat(text_to_format, parameters)

stringFormat(text, format)

stringIndexReplace(text, i_start, i_size, replacement_text)

stringInitCap(text)

stringLeft(text, i_size)

stringLeftWords(text, numberof_words)

stringMD5HashBase16(textString)

stringMD5HashBase64(textString)

stringMiddle(text, i_start, i_size)

stringMiddleWords(text, i_start, numberof_words)

stringPBKDF2Hash(textString)

stringPBKDF2Hash(textString, iterations)

stringPatternCount(text, toSearchFor)

stringPosition(textString, toSearchFor, i_start, i_occurrence)