Command Reference CIB jsMerge

Quick Reference

Here is an overview of all CIB functions with a brief description:

Function

Description

fref(name, {formfieldAttributes})

This function extends the function “text(ref(name))”.  Additional, optional parameters can be passed.
“{formfieldAttributes}“: Attributes used to describe dialog fields; these are currently not interpreted.

text(text)

Copies the value of the passed parameter “text” to the resulting document.

ref(variableName) or
getData(variableName)

Returns the value of the variable “variableName”.

include(name, {includeAttributes})

Inserts the template “name” into the resulting document. “name” can be specified with a relative or absolute path. „{includeAttributes}“: can be specified optionally and control how the template has to be included.

picture(name)

This function is not yet implemented.

Adds the picture “name” to the resulting document. „name” can be specified with a relative or absolute path.

isEmptyRef(variableName)

This function returns “true” if “variableName” has a length of 0 or if the variable cannot be resolved. Otherwise it returns “false”.

existsRef(variableName)

Returns “true” if the variable “variableName” is defined, otherwise it returns “false”.

setData(variableName, value)

Sets the value of the variable “variableName” to the specified “value”.

formatDate(formatString, date)

Returns the formatting of “date” as specified in “formatString”.

deDate()

This function expects a date in the format:
"dd.MM.yyyy"

resetRec(tablealias)

Selects the first record within the table “tablealias” as current dataset.

hasRec(tablealias)

Returns “true” if the current record exists in the table “tablealias”, else it returns “false”.

nextRec(tablealias)

Selects the next entry in the table ”tablealias“.

mergeRec(tablealias)

Returns the number of the currently selected dataset in the table “tablealias“.