External module "formcycle-v6-de.d"

Index

Modules

Interfaces

Variables

Functions

Variables

Const XFC_METADATA

XFC_METADATA: XfcMetadata

Dieses Objekt enthält alle Metadaten des aktuell geöffneten Formulars.

Um über JavaScript Informationen zum Formular, zum aktuell angemeldeten Benutzer und des dazugehörigen Vorgangs sowie vielen weiteren Informationen zu erhalten, steht das globale JavaScript-Objekt window.XFC_METADATA zur Verfügung. Dieses wird beim Aufruf eines Formulars mit den aktuellen Daten automatisch befüllt.

Const XM_FORM_I18N

XM_FORM_I18N: object

Ein Objekt mit allen I18N-Schlüsseln und zugehörigen Werten (Internationalisierung). Etwa findet sich hier die Fehlermeldung, welche erscheint, wenn ein Mussfeld nicht augefüllt wurde.

Type declaration

  • [i18nKey: string]: string

Const XM_FORM_MODEL

XM_FORM_MODEL: XmFormModel

The model for the current form with the validation rules etc. as set in the XIMA form designer.

Const XM_FORM_PLUGIN_VRULES

XM_FORM_PLUGIN_VRULES: Record<string, XmFormPluginVRule>

Ein Objekt mit allen RegExp-Validierungsregeln von Plugins für die verschiedenenen Datentypen von Eingabefeldern. Der Schlüssel ist die ID der Validationsregel, siehe {@link Formcycle.XmFormPluginVRule Formcycle.XmFormPluginVRule.key}).

Const XM_FORM_VRULES

XM_FORM_VRULES: XmFormVrule

Ein Objekt mit allen RegExp-Validierungsregeln für die verschiedenenen Datentypen.

Const xm_validator

xm_validator: XmValidator

Eine Referenz auf dem Formularvalidator. Kann etwa genutzt werden, um mit dem Validierungsprozess zu interagieren, etwa um auf Ereignisse während der Validierung zu lauschen.

Functions

getProjektId

  • getProjektId(): number | null

  • Returns number | null

    Die aktuelle ID des Formulars. null wenn kein Formular gefunden wurde.

getURLParameter

  • getURLParameter(name: string): string | undefined

  • Ermittelt den Wert eines URL-Parameters. Kommt ein URL-Parameter doppelt vor, so wird nur der Wert des ersten URL-Parameters zurückgeliefert.

    Ist die URL etwa:

    https://formcloud.de/formcycle/form/provide/9999?name=Max&preview&mode=&name=Tom

    Dann verhält sich diese Funktion wie folgt:

    getURLParameter("name"); // => "Max"
getURLParameter("preview") // => undefined
getURLParameter("mode"); // => ""
getURLParameter("other"); // => undefined

    Parameters

    • name: string

      Names des zu ermittelnden URL-Parameters.

    Returns string | undefined

    Der Wert des URL-Parameters mit dem gegebenen Namen. undefined, wenn kein solcher URL-Parameter existiert.

gotoPage

  • gotoPage(pageName: string, validate?: boolean): void

  • Ein Formular von XIMA formcycle kann aus mehreren Seiten bestehen. Diese Funktion erlaubt es, von der aktuellen Seite auf eine andere Seite zu wechseln. Zusätzlich kann angegeben werden, ob der Seitenwechsel verhindert werden soll, falls die aktuelle Seite ungültig ist (z.B. bei unausgefüllten Mussfeldern).

    // Wechsel auf Seite 2 nur, wenn alle Eingaben auf der aktuellen Seite gültig sind
gotoPage("p2", true);

// Wechsel auf Seite 2 ohne Überprüfung der Eingaben
gotoPage("p2");

    Parameters

    • pageName: string

      Name der Seite, auf die gewechselt werden soll. Entspricht dem Namen der Seite, wie er im XIMA formcycle-Designer vergeben wurde.

    • Optional validate: boolean

      Falls true, wird der Seitenwechsel verhindert, falls die aktuelle Seite Validierungsfehler aufweist. Bei false wird der Seitenwechsel immer ausgeführt.

    Returns void

setValidate

  • setValidate(doValidate: boolean): void

  • Mittels dieser Funktion kann die Validierung des Formulars ein- oder ausgeschaltet werden. Bei ausgeschalteter Validierung kann das Formular auch abgesendet werden, wenn es ungültig ist und etwa Mussfelder noch nicht ausgefüllt wurden.

    Es ist zu beachten, dass sich diese auf die clientseitige Validierung bezieht. Auch wenn diese aktiviert ist, ist es möglich, ein ungültiges Formular abzuschicken, indem eine entsprechende HTTP-Anfrage ausgeführt wird. Im Designer kann die serverseitige Validierung angeschaltet werden, um dies zu verhindern.

    Parameters

    • doValidate: boolean

      Bei false wird die Validierung deaktiviert. Bei true wird die Validierung aktiviert.

    Returns void