formcycle 8.4.0 - JavaScript for forms
    Preparing search index...

    Interface Window

    interface Window {
        XFC_METADATA: XfcMetadata;
        XM_FORM_I18N: { [i18nKey: string]: string };
        XM_FORM_MODEL: XmFormModel;
        XM_FORM_PLUGIN_VRULES: Record<string, FormcycleDE.XmFormPluginVRule>;
        XM_FORM_VRULES: XmFormVrule;
        xm_validator: XmValidator;
        getProjektId(): number;
        getProjektId(): number;
        getURLParameter(name: string): string;
        getURLParameter(name: string): string;
        gotoPage(pageName: string, validate?: boolean): void;
        gotoPage(pageName: string, validate?: boolean): void;
        setValidate(doValidate: boolean): void;
        setValidate(doValidate: boolean): void;
    }
    Index

    Properties

    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.

    XM_FORM_I18N: { [i18nKey: string]: string }

    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.

    XM_FORM_MODEL: XmFormModel

    Das Modell für das aktuelle Formular mit den Validierungsregeln usw., wie sie im XIMA Formular-Designer festgelegt wurden.

    XM_FORM_PLUGIN_VRULES: Record<string, FormcycleDE.XmFormPluginVRule>

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

    XM_FORM_VRULES: XmFormVrule

    Ein Objekt mit allen RegExp-Validierungsregeln für die verschiedenen Datentypen von Eingabefeldern.

    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.

    Methods

    • Returns number

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

    • Returns number

      The current ID of the form. null when no form exists.

    • 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

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

    • Retrieves the value of the named URL parameter. In case a parameter is specified multiple times, only the value of the first occurrence is returned.

      If the URL is as follows:

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

      Then this function returns:

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

      Parameters

      • name: string

        Name of the URL parameter to retrieve.

      Returns string

      The value of the URL parameter with the given name, or undefined if no such URL parameter exists.

    • 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.

      • Optionalvalidate: boolean

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

      Returns void

    • A formcycle form may consist of multiple pages. This function lets you change to another page. You may also specify whether navigation should be prevented in case the current page is invalid (e.g. due to required fields that are still blank).

      // Go to page 2, but only if all form fields on the current page are valid
      gotoPage("p2", true);

      // Go to page 2 and do not check any form fields
      gotoPage("p2");

      Parameters

      • pageName: string

        The name of the page to goto. This is the name given to the page in the designer.

      • Optionalvalidate: boolean

        Set to true to prevent the page change in case the current page is invalid. Set to false to perform the navigation irrespective of whether the current page is valid.

      Returns 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

    • Lets you disable or enable form validation. If validation is disabled, the form may be submitted event if it is invalid (e.g. when it contains required fields that are still blank).

      Note that even if form validation is enabled, a client may still submit the form if they disable JavaScript or set up an appropriate HTTP request. To prevent this, you may want to enable server side validation in the designer.

      Parameters

      • doValidate: boolean

        Set to false to disable form validation. Set to true to enable form validation.

      Returns void