GlideModalForm : client

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture
  • Affiche un formulaire dans un GlideModal.

    L’utilisation générale de la classe GlideModalForm implique la création de l’objet, la définition des préférences, puis le rendu de GlideModalForm.
    var d = new GlideModalForm('dialog title', 'table_name_or_form_name', [callback on completion of submit])
             d.setPreference('name', 'value');
             d.render();

    Spécifiez les paramètres de requête qui sont passés au formulaire à l’aide de setPreference(). Toute paire nom/valeur que vous spécifiez avec setPreference() est envoyée avec la requête POST du formulaire pour afficher le formulaire.

    Le formulaire GlideModalForm est défini pour remplir la hauteur de la fenêtre de document.

    GlideModalForm : GlideModalForm(titre de chaîne, nom de table de chaîne, fonction onCompletionCallback, booléen readOnly)

    Crée une instance de la classe GlideModalForm.

    Tableau 1. Paramètres
    Nom Type Description
    Titre Chaîne Titre du formulaire modal.
    tableName Chaîne Table affichée.
    onCompletionCallback Fonction Fonction à appeler une fois que le formulaire a été soumis et traité sur le serveur.

    La fonction de rappel se présente sous la formecallbackFunction(String action_verb, String sys_id, String table, String displayValue) où :

    • action_verb: nom de l’action d’interface utilisateur exécutée. Par exemple, sysverb_insert (bouton Soumettre), sysverb_cancel sysverb_save (bouton Enregistrer).
    • sys_id: Sys_id de l’enregistrement affecté.
    • table: nom de la table contenant l’enregistrement.
    • displayValue: valeur qui apparaît sur le formulaire.
    readOnly Booléen Facultatif. Marqueur indiquant si le formulaire modal doit être défini sur lecture seule.
    Valeurs valides :
    • true : définit le formulaire en lecture seule.
    • false : défini pour lecture/écriture.

    Valeur par défaut : false

    Cet exemple montre comment instancier un objet GlideModalForm.

    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(nom de chaîne, valeur de chaîne)

    Définit le champ de formulaire spécifié sur la valeur spécifiée.

    Tableau 2. Paramètres
    Nom Type Description
    nom Chaîne Nom de champ de formulaire. Si le nom spécifié n’est pas un champ dans le formulaire modal associé, il est ignoré.
    valide Chaîne Valeur à laquelle appliquer le champ de formulaire spécifié.
    Tableau 3. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler addParm() pour définir la valeur du champ sys_id du formulaire modal.

    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(chaîne sys_id)

    Définit la préférence sys_id de l’objet.

    Tableau 4. Paramètres
    Nom Type Description
    sys_id Chaîne La préférence d’ID. L’un des paramètres de requête transmis au formulaire.
    Tableau 5. Renvoie
    Type Description
    nul

    Cet exemple montre comment utiliser la méthode setSysID() pour initialiser la valeur de l’sys_id.

    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)

    Définit la fonction à appeler lorsque le formulaire a été soumis et traité avec succès par le serveur.

    Tableau 6. Paramètres
    Nom Type Description
    fonction de rappel Fonction Fonction de rappel à appeler lorsque le formulaire a été traité avec succès.
    La fonction de rappel se présente sous la forme callbackFunction(String action_verb, String sys_id, String table, String displayValue) où :
    • action_verb: action_name à partir d’un enregistrement sys_ui_action
    • sys_id: Sys_id de l’enregistrement affecté
    • table: nom de la table contenant l’enregistrement
    • displayValue: valeur qui apparaît sur le formulaire
    Tableau 7. Renvoie
    Type Description
    nul

    Cet exemple montre comment définir la fonction de rappel onload du modal associé.

    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)

    Définit la fonction à appeler une fois que le formulaire a été chargé.

    Tableau 8. Paramètres
    Nom Type Description
    fonction de rappel Fonction Fonction à appeler après le chargement du formulaire. La fonction de rappel a la forme callBackFunction(GlideModalForm obj)
    Tableau 9. Renvoie
    Type Description
    nul

    Cet exemple montre comment définir la fonction de rappel au chargement du modal associé.

    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()

    Affiche le formulaire modal.

    Tableau 10. Paramètres
    Nom Type Description
    Aucun
    Tableau 11. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler render() pour afficher le modal.

    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();
    }