Diese JavaScript-Hilfe gibt es für jede Version von formcycle. Hier klicken, um die Hilfe für eine andere formcycle-Version einzusehen.
Auf dieser Seite findet sich die Dokumentation zu allen JavaScript-Funktionen, die im Formular bereitstehen und genutzt werden können. Im Folgenden eine kurze Übersicht, welche Arten von Funktionen es gibt und wo diese zu finden sind.
Alle in dieser Hilfe beschriebenen Funktionen stehen auch für die Autovervollständigung im JavaScript-Bereich des Designers zur Verfügung.
Wie kann überhaupt auf formcycle-spezifische Funktionen und Objekte zugegriffen werden? Hier gibt es die folgenden Möglichkeiten, unten noch genauer erläutert:
window) GeltungsbereichEinige wenige Funktionen und Objekte stehen direkt im globalen Geltungsbereich zu Verfügung. Auf diese wird zugegriffen,
indem entweder der Name direkt genutzt wird oder auf die entsprechende Eigenschaft des window-Objekts zugegriffen
wird. Zum Beispiel:
// Zugriff auf das globale Objekte "XFC_METADATA" und den Untereintrag "serverTime"
window.XFC_METADATA.serverTime;
// Es kann auch direkt ohne "window." zugegriffen werden.
XFC_METADATA.serverTime;Diese Funktionen und Objekte sind in dieser Hilfe unter formcycle/window zu finden.
Um den globalen Geltungsbereich nicht zu verschmutzen, werden neue Funktionen nun meist im formcycle-Objekt
jQuery.xutil abgelegt. Auf dieses wird mit dem Präfix $.xutil zugegriffen:
// Holt den Wert des URL-Parameters mit dem Namen "lang" (Sprache)
$.xutil.getFormParam("lang");Diese Funktionen und Objekte sind in dieser Hilfe unter formcycle/XUtil zu finden.
Für die Formulare von formcycle wird die Bibliothek JQuery benutzt. Nach dem Selektieren von HTML-Elementen über JQuery bietet diese Bibliothek eine Vielzahl von Funktionen, um mit diesen Elementen weiter zu arbeiten. Zudem erlaubt JQuery es, hier neue Funktionen hinzuzufügen.
formcycle bietet viele Funktionen, die auf Elemente angewendet werden können, die mit JQuerys selektiert wurden:
// Selektieren des Elements "tfID" mit JQuery
const tfID = $("[name='tfID']");
// Benutzerdefinierte Validierung des Felds tfID
tfMail.errorFunc(() => this.value.length === 5 ? "" : "ID muss 5 Stellen haben.");Diese Funktionen sind in dieser Hilfe unter formcycle/JQuery zu finden.
Die Bibliothek JQuery wird von formcycle genutzt und mit ausgeliefert. Der Vollständigkeit halber findet sich die Dokumentation von JQuery auch noch einmal in dieser Hilfe unter jquery.