formcycle 8.3.6 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle XUtilCallbacks

    Zuordnung zwischen Ereignisnamen und Rückruffunktionstypen für Rückrufe, die über XUtil.on registriert werden können.

    interface XUtilCallbacks {
        addRow: (params: XUtilOnAddRowData) => void;
        afterLoadFormData: (params: XUtilOnAfterLoadFormDataData) => void;
        afterPrint: (params: XUtilOnAfterPrintData) => void | Promise<void>;
        beforeAddRow: (
            params: XUtilOnBeforeAddRowData,
        ) => void | XUtilOnBeforeAddRowResult;
        beforeClearAll: (params: XUtilOnBeforeClearAllData) => void;
        beforeDeleteRow: (
            params: XUtilOnBeforeDeleteRowData,
        ) => void | XUtilOnBeforeDeleteRowResult;
        beforeLoadFormData: (
            params: XUtilOnBeforeLoadFormDataData,
        ) => void | XUtilOnBeforeLoadFormDataResult;
        beforeResetAll: (params: XUtilOnBeforeResetAllData) => void;
        clear: (params: XUtilOnClearData) => void;
        deleteRow: (params: XUtilOnDeleteRowData) => void;
        disable: (params: XUtilOnDisableData) => void;
        enable: (params: XUtilOnEnableData) => void;
        fileChange: (params: XUtilOnFileChangeData) => void;
        hide: (params: XUtilOnHideData) => void;
        loadNavigation: (
            params: XUtilOnLoadNavigationData,
        ) => void | XUtilOnLoadNavigationResult;
        print: (params: XUtilOnPrintData) => void | Promise<void>;
        readOnly: (params: XUtilOnReadOnlyData) => void;
        resetAll: (params: XUtilOnResetAllData) => void;
        saveNavigation: (
            params: XUtilOnSaveNavigationData,
        ) => void | XUtilOnSaveNavigationResult;
        show: (params: XUtilOnShowData) => void;
        submit: (params: XUtilOnSubmitData) => void | XUtilOnSubmitResult;
    }
    Index

    Eigenschaften

    addRow afterLoadFormData afterPrint beforeAddRow beforeClearAll beforeDeleteRow beforeLoadFormData beforeResetAll clear deleteRow disable enable fileChange hide loadNavigation print readOnly resetAll saveNavigation show submit

    Eigenschaften

    addRow: (params: XUtilOnAddRowData) => void

    Wenn eine Zeile mit einem wiederholten Element oder Container hinzugefügt wurde.

    Typendeklaration

    afterLoadFormData: (params: XUtilOnAfterLoadFormDataData) => void

    Rückruffunktion, wenn Formulardaten per $.xutil.load geladen wurden. Diese Rückruffunktion wird grufen, nachdem die Formulardaten geladen und das Formular mit den neuen Daten aktualisiert wurde. Die Rückruffunktion kann etwa für zusätzliche Aktionen nach dem Laden der Daten verwendet werden, wie etwa das Aktualisieren der UI von von Widgets.

    Typendeklaration

    afterPrint: (params: XUtilOnAfterPrintData) => void | Promise<void>

    Ein Rückruf zum Drucken des Formulars. Die Rückrufe werden nach dem Drucken eines Formulars aufgerufen (z. B. durch den Druckdienst). Sie können diesen Rückruf verwenden, um Vorbereitungen rückgängig zu machen, die durch print getroffen wurden.

    Typendeklaration

      • (params: XUtilOnAfterPrintData): void | Promise<void>

      • Parameter

        Rückgabewert void | Promise<void>

        Ein Promise, das aufgelöst wird, wenn die Bereinigung abgeschlossen ist.

    beforeAddRow: (
        params: XUtilOnBeforeAddRowData,
    ) => void | XUtilOnBeforeAddRowResult

    Bevor eine Zeile zu einer Wiederholung eines Elements oder Containers hinzugefügt wird.

    Typendeklaration

    beforeClearAll: (params: XUtilOnBeforeClearAllData) => void

    Bevor die Werte einer Gruppe von Formularelementen gelöscht werden.

    Daten mit dem Formularelement.

    beforeDeleteRow: (
        params: XUtilOnBeforeDeleteRowData,
    ) => void | XUtilOnBeforeDeleteRowResult

    Bevor eine Zeile von einer Wiederholung eines Elements oder Containers hinzugefügt wird.

    Typendeklaration

    beforeLoadFormData: (
        params: XUtilOnBeforeLoadFormDataData,
    ) => void | XUtilOnBeforeLoadFormDataResult

    A callback for when form data is about to be loaded via $.xutil.load. This callback is invoked at the beginning, before any other form data was loaded. You can use this callback to perform additional actions, such as adjusting the DOM or inserting additional form data. You can also use the return value to exclude certain elements from the default handler that loads all data for .XItem elements.

    Typendeklaration

    beforeResetAll: (params: XUtilOnBeforeResetAllData) => void

    Bevor die Werte einer Gruppe von Formularelementen auf ihre Standardwerte zurückgesetzt werden.

    Daten mit dem Formularelement.

    clear: (params: XUtilOnClearData) => void

    Wenn der Wert eines Formularelements gelöscht wurde.

    Daten mit dem Formularelement.

    deleteRow: (params: XUtilOnDeleteRowData) => void

    Wenn eine Zeile mit einem wiederholten Element oder Container gelöscht wurde.

    Typendeklaration

    disable: (params: XUtilOnDisableData) => void

    Wenn ein Formularelement deaktiviert wurde.

    Daten mit dem Formularelement.

    enable: (params: XUtilOnEnableData) => void

    Wenn ein Formularelement aktiviert wurde.

    Daten mit dem Formularelement.

    fileChange: (params: XUtilOnFileChangeData) => void

    Wenn eine Datei geändert wurde, sowohl für normale als auch für automatische Upload-Elemente.

    Daten mit dem Formular-Upload-Element.

    hide: (params: XUtilOnHideData) => void

    Wenn ein Formularelement von sichtbar auf ausgeblendet umgeschaltet wurde.

    Daten mit dem Formularelement.

    loadNavigation: (
        params: XUtilOnLoadNavigationData,
    ) => void | XUtilOnLoadNavigationResult

    Wenn der aktuelle Navigationszustand wiederhergestellt wird, z. B. welche Seiten derzeit angezeigt werden. Listener können benutzerdefinierten Zustand wiederherstellen, der über das saveNavigation-Ereignis gespeichert wurde. Der Navigationszustand, der von Listenern für saveNavigation zurückgegeben wurde, wird als Argument an das loadNavigation-Ereignis übergeben.

    Typendeklaration

    print: (params: XUtilOnPrintData) => void | Promise<void>

    Ein Rückruf für den Druckdienst. Die Rückrufe werden aufgerufen, kurz bevor ein Formular gedruckt wird (z. B. durch den Druckdienst). Sie können diesen Rückruf verwenden, um das Formular für den Druck vorzubereiten. Wenn der Rückruf ein Promise zurückgibt, wartet der Druckdienst darauf, dass das Promise erfüllt wird, bevor das Formular gedruckt wird. Wenn das Promise abgelehnt wird, wird der Fehler protokolliert, verhindert jedoch nicht den Druck.

    Verwenden Sie afterPrint, um nach dem Drucken aufzuräumen.

    Typendeklaration

      • (params: XUtilOnPrintData): void | Promise<void>

      • Parameter

        • params: XUtilOnPrintData

          Daten, die vom Framework für den Druckvorgang übergeben werden.

        Rückgabewert void | Promise<void>

        Ein Promise, das abschließt, wenn die Vorbereitungen abgeschlossen sind.

    readOnly: (params: XUtilOnReadOnlyData) => void

    Wenn ein Formularelement auf schreibgeschützt gesetzt wurde.

    Daten mit dem Formularelement.

    resetAll: (params: XUtilOnResetAllData) => void

    Wenn eine Gruppe von Formularelementen ihre Werte auf die Standardwerte zurückgesetzt hat.

    Daten mit dem Formularelement.

    saveNavigation: (
        params: XUtilOnSaveNavigationData,
    ) => void | XUtilOnSaveNavigationResult

    Wenn der aktuelle Navigationszustand gespeichert wird, z. B. welche Seiten derzeit angezeigt werden. Listener können benutzerdefinierten Zustand zurückgeben, der gespeichert werden soll. Kann in Verbindung mit dem loadNavigation-Ereignis verwendet werden, um den Zustand später wiederherzustellen. Der von Listenern zurückgegebene Navigationszustand wird als Argument an das loadNavigation-Ereignis übergeben.

    Typendeklaration

    show: (params: XUtilOnShowData) => void

    Wenn ein Formularelement von ausgeblendet auf sichtbar umgeschaltet wurde.

    Daten mit dem Formularelement.

    submit: (params: XUtilOnSubmitData) => void | XUtilOnSubmitResult

    Ein Rückruf für das Absenden des Formulars. Kann z. B. verwendet werden, um zusätzliche Aktionen auszuführen oder das Absenden zu verhindern.

    Der Rückruf wird aufgerufen, nachdem das Formular validiert wurde, wenn die Absenden-Schaltfläche eine Validierung erfordert.

    $.xutil.on("submit", () => doSomething())

    $.xutil.on("submit", ({submissionBlocked}) => {
      // Überprüfen, ob das Absenden bereits blockiert ist
      if (submissionBlocked) {
        return;
      }

      // Benutzerdefinierter Code, der beim Absenden ausgeführt werden soll
      // Benutzerdefinierte Logik, um zu überprüfen, ob das Formular abgebrochen werden soll.
       const preventSubmission = customLogic();

       return { preventSubmission };
    });

    Typendeklaration

    Einstellungen

    Member-Sichtbarkeit

    Auf dieser Seite

    Eigenschaften