Child pages
  • Utils
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Unknown macro: {div}

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'

Unknown macro: {div}


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

dateFormat(date, format)
Format a date object to a text representation.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getUnicodeCharacter(unicodeCharacterNumber)
Returns a string containing the character for the unicode number.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

hasRecords(record, relationString)
Returns true if the (related)foundset exists and has records.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

numberFormat(number, digits)
Format a number to have a defined fraction.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

numberFormat(number, format)
Format a number to specification.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

parseDate(date, format)
Parse a string to a date object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringEscapeMarkup(textString)
Returns the escaped markup text (HTML/XML).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringEscapeMarkup(textString, escapeSpaces)
Returns the escaped markup text (HTML/XML).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringEscapeMarkup(textString, escapeSpaces, convertToHtmlUnicodeEscapes)
Returns the escaped markup text (HTML/XML).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringFormat(text_to_format, parameters)
Formats a string according to format specifiers and arguments.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringIndexReplace(text, i_start, i_size, replacement_text)
Replaces a portion of a string with replacement text from a specified index.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringLeft(text, i_size)
Returns a string with the requested number of characters, starting from the left.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringLeftWords(text, numberof_words)
Returns the number of words, starting from the left.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringMiddle(text, i_start, i_size)
Returns a substring from the original string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringMiddleWords(text, i_start, numberof_words)
Returns a substring from the original string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringPBKDF2Hash(textString)
Returns the PBKDF2 hash for specified text.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringPBKDF2Hash(textString, iterations)
Returns the PBKDF2 hash for specified text.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

stringPatternCount(text, toSearchFor)
Returns the number of times searchString appears in textString.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

stringPosition(textString, toSearchFor, i_start, i_occurrence)
Returns the position of the string to search for, from a certain start position and occurrence.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringReplace(text, search_text, replacement_text)
Replaces a portion of a string with replacement text.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringRight(text, i_size)
Returns a string with the requested number of characters, starting from the right.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

stringToNumber(textString)
Filters characters out of from a string and leaves digits, returns the number.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

stringToNumber(textString, decimalSeparator)
Filters characters out of from a string and leaves digits, returns the number.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

stringTrim(textString)
Returns the string without leading or trailing spaces.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

stringWordCount(text)
Returns the number of words in the text string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

validatePBKDF2Hash(password, hash)
Validates the given password against the given hash.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
dateFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

dateFormat

Unknown macro: {span}

(date, format)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the date as text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var formattedDateString = utils.dateFormat(dateobject,'EEE, d MMM yyyy HH:mm:ss');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getUnicodeCharacter
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getUnicodeCharacter

Unknown macro: {span}

(unicodeCharacterNumber)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} unicodeCharacterNumber – the number indicating the unicode character

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a string containing the unicode character

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns a big dot
var dot = utils.getUnicodeCharacter(9679);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
hasRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

hasRecords

Unknown macro: {span}

(foundset)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFoundSet} foundset – the foundset to be tested

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if exists

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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
//}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
hasRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

hasRecords

Unknown macro: {span}

(record, relationString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the foundset/relation has records.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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
//}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
isMondayFirstDayOfWeek
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

isMondayFirstDayOfWeek

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if(utils.isMondayFirstDayOfWeek())
{
	//a date calculation
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
numberFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

numberFormat

Unknown macro: {span}

(number, digits)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting number in text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var textalNumber = utils.numberFormat(16.749, 2); //returns 16.75
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
numberFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

numberFormat

Unknown macro: {span}

(number, format)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting number in text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var textalNumber2 = utils.numberFormat(100006.749, '#,###.00'); //returns 100,006.75
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
parseDate
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Date

Unknown macro: {span}

parseDate

Unknown macro: {span}

(date, format)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Date – the date as date object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var parsedDate = utils.parseDate(datestring,'EEE, d MMM yyyy HH:mm:ss');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringEscapeMarkup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringEscapeMarkup

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the escaped text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringEscapeMarkup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringEscapeMarkup

Unknown macro: {span}

(textString, escapeSpaces)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the escaped text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringEscapeMarkup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringEscapeMarkup

Unknown macro: {span}

(textString, escapeSpaces, convertToHtmlUnicodeEscapes)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the escaped text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringFormat

Unknown macro: {span}

(text_to_format, parameters)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the formatted text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringIndexReplace
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringIndexReplace

Unknown macro: {span}

(text, i_start, i_size, replacement_text)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the changed text string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'this was a test'
var retval = utils.stringIndexReplace('this is a test',6,2,'was');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringInitCap
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringInitCap

Unknown macro: {span}

(text)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} text – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the changed text

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'This Is A Test'
var retval = utils.stringInitCap('This is A test');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringLeft
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringLeft

Unknown macro: {span}

(text, i_size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the result text string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'this i'
var retval = utils.stringLeft('this is a test',6);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringLeftWords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringLeftWords

Unknown macro: {span}

(text, numberof_words)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the string with number of words form the left

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'this is a'
var retval = utils.stringLeftWords('this is a test',3);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringMD5HashBase16
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringMD5HashBase16

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting hashString

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var hashed_password = utils.stringMD5HashBase16(user_password)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringMD5HashBase64
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringMD5HashBase64

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting hashString

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var hashed_password = utils.stringMD5HashBase64(user_password)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringMiddle
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringMiddle

Unknown macro: {span}

(text, i_start, i_size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the result text string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'his'
var retval = utils.stringMiddle('this is a test',2,3);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringMiddleWords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringMiddleWords

Unknown macro: {span}

(text, i_start, numberof_words)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'is a'
var retval = utils.stringMiddleWords('this is a test',2,2);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringPBKDF2Hash
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringPBKDF2Hash

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting hashString

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var hashed_password = utils.stringPBKDF2Hash(user_password)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringPBKDF2Hash
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringPBKDF2Hash

Unknown macro: {span}

(textString, iterations)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting hashString

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var hashed_password = utils.stringPBKDF2Hash(user_password,5000)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringPatternCount
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

stringPatternCount

Unknown macro: {span}

(text, toSearchFor)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 2 as count
var count = utils.stringPatternCount('this is a test','is');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringPosition
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

stringPosition

Unknown macro: {span}

(textString, toSearchFor, i_start, i_occurrence)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the position

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 4 as position
var pos = utils.stringPosition('This is a test','s',1,1)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringReplace
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringReplace

Unknown macro: {span}

(text, search_text, replacement_text)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the changed text string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'these are cow 1 and cow 2.'
var retval = utils.stringReplace('these are test 1 and test 2.','test','cow');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringReplaceTags
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringReplaceTags

Unknown macro: {span}

(text, scriptable)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the text with replaced tags

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringRight
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringRight

Unknown macro: {span}

(text, i_size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the result text string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'a test'
var retval = utils.stringLeft('this is a test',6);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringRightWords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringRightWords

Unknown macro: {span}

(text, numberof_words)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the string with number of words form the right

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'is a test'
var retval = utils.stringRightWords('this is a test',3);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringToNumber
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

stringToNumber

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the resulting number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 65567
var retval = utils.stringToNumber('fg65gf567');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringToNumber
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

stringToNumber

Unknown macro: {span}

(textString, decimalSeparator)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the resulting number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 65.567
var retval = utils.stringToNumber('fg65gf.567','.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringTrim
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

stringTrim

Unknown macro: {span}

(textString)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} textString – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the resulting trimmed string

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns 'text'
var retval = utils.stringTrim('   text   ');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
stringWordCount
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

stringWordCount

Unknown macro: {span}

(text)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} text – the text to process

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the word count

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//returns '4' as result
var retval = utils.stringWordCount('this is a test');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
timestampToDate
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Date

Unknown macro: {span}

timestampToDate

Unknown macro: {span}

(date)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Date – the stripped date object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var date = utils.timestampToDate(application.getTimeStamp());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
validatePBKDF2Hash
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

validatePBKDF2Hash

Unknown macro: {span}

(password, hash)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} password – the password to test against
{String} hash – the hash the password needs to validate to.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if his hash is valid for that password

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if (utils.validatePBKDF2Hash(user_password, hashFromDb)) {
   // logged in 
}
Unknown macro: {tr}
Unknown macro: {td}
  • No labels