Zum Hauptinhalt springen

Events Mappentyp eFileKeyword

Dieses Skript enthält Callbacks für den Mappentyp eFileKeyword .

tipp

Zum Aktivieren der Callbacks muss das Skript ou.tmpl.eFileKeyword.callbacks.events in ou.cust.eFileKeyword.callbacks.events umbenannt werden.

Verwendung​

Für was kann ich diese Callbacks verwenden?​

  • Wenn man benutzerdefinierte Aktionen ein/ausblenden möchte (approvedButtons)
  • Speichern der Mappe beeinflussen möchte

Welche Callbacks sind definiert?​

  • approvedButton: Benutzerdefinierte Aktionen an der Mappe einstellen
  • onSave: Wird getriggert, beim Speichern einer Mappe

Callbacks​

approvedButton​

Dieser Callback wird für JEDE benutzerdefinierte Aktion getriggert.

approvedButton(data: {
    name:string,
    index:number,
    enumval:Array<string>
}): boolean | void;

Hier kann die Sichtbarkeit der benutzerdefinierte Aktion festgelegt werden, z. B.

approvedButton: function(data) {
    /**
     * @type {eFileKeyword}
     */
    var docFile = context.file;

    // Button myCustomButton im Status 99 ausblenden
    if (data.name == "myCustomButton" && docFile.globalState === "99") {
        return false;
    }
}

Wird kein Wert zurückgegeben, wird der Button angezeigt.

onSave​

Dieser Callback wird getriggert, wenn eine Mappe gespeichert wird.

onSave(): void;

Abbruch über eine Exception.

onSave: () => {
    /**
     * @type {eFileKeyword}
     */
    var docFile = context.file;

    if (!docFile.myCustomField) {
        throw new Error("Pflichtfeld XYZ ist leer.");
    }
},