Utils

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}

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}

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: {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}

Unknown macro: {div}

Format a date object to a text representation.

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}

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}

Unknown macro: {div}

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

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}

Unknown macro: {div}

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

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}

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}

Unknown macro: {div}

Format a number to have a defined fraction.

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}

Unknown macro: {div}

Format a number to specification.

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}

Child pages

Utils

dateFormat

hasRecords

hasRecords

numberFormat

numberFormat