GlideModalForm : Client

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer
  • Die GlideModalForm -API bietet Methoden zum Anzeigen eines Formulars in einem GlideModal.

    Die allgemeine Verwendung der GlideModalForm- Klasse umfasst das Erstellen des Objekts, das Festlegen von Einstellungen und das anschließende Rendern der GlideModalForm.
    var dialog = new GlideModalForm('dialog title', 'table_name_or_form_name', [callback on completion of submit])
      dialog.setPreference('name', 'value');
      dialog.render();

    Geben Sie die Abfrageparameter an, die mit der Methode setPreference() an das Formular übergeben werden. Jedes Name/Wert-Paar, das Sie mit setPreference() angeben, wird zusammen mit der Formular-POST-Anforderung gesendet, um das Formular anzuzeigen.

    Die GlideModalForm wird so festgelegt, dass sie die Höhe des Dokumentfensters ausfüllt.

    GlideModalForm – GlideModalForm(Zeichenfolgentitel, Zeichenfolgentabellenname, Funktion onCompletionCallback, Boolesche lesbare Farbe)

    Erstellt eine Instanz der GlideModalForm-Klasse.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    title Zeichenfolge Titel des modalen Formulars.
    tableName Zeichenfolge Tabelle wird angezeigt.
    onCompletionCallback Funktion Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde.

    Die Rückruffunktion weist das Format„callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei:

    • action_verb: Name der ausgeführten UI-Aktion. Beispiele sind sysverb_insert (Schaltfläche „Absenden“), sysverb_cancel und sysverb_save (Schaltfläche „Speichern“).
    • sys_id: Sys_id des betroffenen Datensatzes.
    • table: Name der Tabelle, die den Datensatz enthält.
    • displayValue: Wert, der im Formular angezeigt wird.
    readOnly Boolean Optional. Kennzeichnung, die angibt, ob das modale Formular schreibgeschützt festgelegt werden soll.
    Gültige Werte:
    • „wahr“: Formular als schreibgeschützt festlegen.
    • „falsch“: Legen Sie für auf Lesen/Schreiben fest.

    Standardwert: false

    In diesem Beispiel wird gezeigt, wie ein GlideModalForm-Objekt instanziiert wird.

    function openDevice(deviceSysID, deviceName) {
      var uName = gel('hidden_user_name').value + "'s ";
      deviceName = new String(deviceName).escapeHTML();
      var gp = new GlideModalForm(uName + deviceName, "cmn_notif_device", refreshNotifPage);
      gp.addParm('sys_id', deviceSysID);
      gp.render();
    }

    GlideModalForm – addParm(String name, String value)

    Legt das angegebene Formularfeld auf den angegebenen Wert fest.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Formularfeldname. Wenn der angegebene Name kein Feld im zugeordneten modalen Formular ist, wird er ignoriert.
    Wert Zeichenfolge Wert, auf den das angegebene Formularfeld festgelegt werden soll.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    void

    In diesem Beispiel wird gezeigt, wie addParm () aufgerufen wird, um den Wert des Felds „sys_id“ im modalen Formular festzulegen.

    function openDevice(deviceSysID, deviceName) {
      var uName = gel('hidden_user_name').value + "'s ";
      deviceName = new String(deviceName).escapeHTML();
      var gp = new GlideModalForm(uName + deviceName, "cmn_notif_device", refreshNotifPage);
      gp.addParm('sys_id', deviceSysID);
      gp.render();
    }

    GlideModalForm – setSysID(String sys_id)

    Legt die sys_id-Voreinstellung des Objekts fest.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge Id-Voreinstellung Einer der an das Formular übergebenen Abfrageparameter.
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie Sie mit der Methode setSysID() den Wert der sys_id initialisieren.

    function(startDate, endDate) {
      var dialog = new GlideModalForm("Add Schedule Item", "cmn_schedule_span");
      dialog.setSysID("-1");
      dialog.addParm("sysparm_collection", "cmn_schedule");
      dialog.addParm("sysparm_collectionID", this.sysId);
      dialog.addParm("sysparm_collection_key", "schedule");
     
      var q = "schedule=" + this.sysId + "^start_date_time="
       + startDate.serializeInUserFormat() + "^end_date_time="
       + endDate.serializeInUserFormat() + "^";
    
      if (startDate.isAllDay(endDate))
        q += "^all_day=true^";
     
      dialog.addParm("sysparm_query", q);
      dialog.render();
    }

    GlideModalForm – setCompletionCallback(Function callbackFunction)

    Legt fest, dass die Funktion aufgerufen wird, wenn das Formular erfolgreich vom Server übermittelt und verarbeitet wurde.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    callbackFunction Funktion Rückruffunktion zum Aufrufen, wenn das Formular erfolgreich verarbeitet wurde.
    Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei:
    • action_verb: action_name aus einem sys_ui_action-Datensatz
    • sys_id: Sys_id des betroffenen Datensatzes
    • table: Name der Tabelle, die den Datensatz enthält
    • displayValue: Wert, der im Formular angezeigt wird
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    void

    In diesem Beispiel wird gezeigt, wie die Onload-Callback-Funktion des zugehörigen Modals festgelegt wird.

    function handleCreateOrEdit(targetFieldName, sourceFieldName, adapterRuleId, transformerSysId){
      dialog = new GlideModalForm('Edit Adapter Rule', "sys_adapter_rule");
      dialog.setSysID(adapterRuleId); //Pass in sys_id to edit existing record
      dialog.addParm('sysparm_form_only', 'true'); //Add or remove related lists
      dialog.setOnloadCallback(hideModalForm);
      dialog.setCompletionCallback(handleAdapterCreatedOrUpdated);
      dialog.render(); //Open the dialog
    }
    function handleAdapterCreatedOrUpdated(action_verb, sys_id, table, displayValue) {
      var draftRecordTransformer = g_form.getValue("draft_record_transformer");
      if(draftRecordTransformer == null || draftRecordTransformer.length == 0) {
        //sync Sticky Replications if it is enabled.
        var ajax = new GlideAjax('ReplicationPoolUtil');
        ajax.addParam('sysparm_name', 'syncStickyReplicationSet');
        ajax.addParam('sysparm_entry_set', g_form.getValue("entry_set"));
        ajax.getXMLWait();
      }
    }

    GlideModalForm – setOnloadCallback(Function callbackFunction)

    Legt fest, dass die Funktion aufgerufen wird, nachdem das Formular geladen wurde.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    callbackFunction Funktion Funktion, die aufgerufen werden soll, nachdem das Formular geladen wurde. Die Rückruffunktion hat das Formular callBackFunction(GlideModalForm obj).
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    void

    In diesem Beispiel wird gezeigt, wie die Funktion „Rückruf beim Laden“ des zugehörigen Modals festgelegt wird.

    function handleCreateOrEdit(targetFieldName, sourceFieldName, adapterRuleId, transformerSysId){
      dialog = new GlideModalForm('Edit Adapter Rule', "sys_adapter_rule");
      dialog.setSysID(adapterRuleId); //Pass in sys_id to edit existing record
      dialog.addParm('sysparm_form_only', 'true'); //Add or remove related lists
      dialog.setOnloadCallback(hideModalForm);
      dialog.setCompletionCallback(handleAdapterCreatedOrUpdated);
      dialog.render(); //Open the dialog
    }

    GlideModalForm – render()

    Zeigt das modale Formular an.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    void

    In diesem Beispiel wird gezeigt, wie render() aufgerufen wird, um das Modal anzuzeigen.

    function openDevice(deviceSysID, deviceName) {
      var uName = gel('hidden_user_name').value + "'s ";
      deviceName = new String(deviceName).escapeHTML();
      var gp = new GlideModalForm(uName + deviceName, "cmn_notif_device", refreshNotifPage);
      gp.addParm('sys_id', deviceSysID);
      gp.render();
    }