JavaScript API

FORMCYCLE provides a multitude of objects and utility functions to help you with creating complex forms easily.

Please refer to the help pages that are available for each release of FORMCYCLE at https://docs.formcycle.eu

Functions on jQuery objects

These functions are called directly on form and HTML elements that were selected with jQuery:

// Hide the form field named "tfZip"
$("[name='tfZip']").visible(false);

• jQuery.fn.addStar / jQuery.fn.removeStar / jQuery.fn.showStar
• jQuery.fn.appointmentPicker
• jQuery.fn.autocompleteDB / jQuery.fn.autocompleteLDAP / jQuery.fn.autocompleteQuery
• jQuery.fn.autonumeric
• jQuery.fn.clear
• jQuery.fn.cob2auto
• jQuery.fn.counter
• jQuery.fn.dynamic
• jQuery.fn.error
• jQuery.fn.errorFunc
• jQuery.fn.getContainer
• jQuery.fn.getLabel
• jQuery.fn.hasAttr
• jQuery.fn.jSignature
• jQuery.fn.on
• jQuery.fn.replaceParams
• jQuery.fn.setDataType
• jQuery.fn.setError
• jQuery.fn.setGroupReq
• jQuery.fn.setMinCheckBox / jQuery.fn.setMaxCheckBox
• jQuery.fn.setMinLength / jQuery.fn.setMaxLength
• jQuery.fn.setMinValue / jQuery.fn.setMaxValue
• jQuery.fn.setMustEqual
• jQuery.fn.setRequired
• jQuery.fn.setRequiredIf
• jQuery.fn.sum
• jQuery.fn.validate
• jQuery.fn.vattr
• jQuery.fn.visible

xutil

These functions and properties are available in the global object $.xutil:

// Returns the URL for accessing a CSV data source (as configured in the backend)
// For example "/formcycle/datenquellecsv/"
$.xutil.getFormUrl("datasource_csv")

• xutil.ajaxUploadDialog
• xutil.ajaxUploadManager
• xutil.appointmentPicker
• xutil.hash
• xutil.inputElementCounter
• xutil.onready
• xutil.ready
• xutil.drawImagePreview
• xutil.getDataQuery
• xutil.getFormParam
• xutil.getFormUrl
• xutil.getLdapQuery
• xutil.isStatus
• xutil.load
• xutil.loadFromString
• xutil.off
• xutil.offSubmit
• xutil.on
• xutil.onPrint
• xutil.onReadyStateComplete
• xutil.onStatus
• xutil.onSubmit
• xutil.onsubmit
• xutil.parseFloat
• xutil.save
• xutil.saveAsString
• xutil.trigger

window

These functions and objects are available in the global window scope:

// Go to the page named "p2"
gotoPage("p2");

• window.getProjektId
• window.getURLParameter
• window.gotoPage
• window.setValidate
• window.xm_validator
• window.XFC_METADATA
• window.XM_FORM_I18N
• window.XM_FORM_MODEL
• window.XM_FORM_PLUGIN_VRULES
• window.XM_FORM_VRULES