15.2 Paramètres de module

Un Paramètre de module est un paramètre créé dans FormsStudio. En revanche, la valeur du paramètre n’est pas spécifiée dans FormsStudio mais dans le portail Administrateur d’Easily.

15.2.1        Types de paramètre

Il existe plusieurs types de paramètre permettant de stocker différents types de données.

Texte

Paramètre simple dont la valeur contient du Texte. Ce paramètre peut par exemple servir à stocker une chaine de connexion propre à un module. Il est aussi utilisé pour stocker l’en-tête à utiliser dans les impressions PDF des fiches Dominho.

Fichier

Paramètre dont la valeur correspond à un fichier téléchargé par l’utilisateur. Ce paramètre peut stocker un fichier, une image (notamment l’image utilisée pour l’en-tête des impressions PDF des fiches Dominho).

Sélection de formulaire

Paramètre dont la valeur correspond à un formulaire sélection. Il est utilisé lors du requêtage d’un formulaire ne faisant pas partie du module courant.

 

15.2.2        Ajout et assignation de valeurs

Pour ajouter un paramètre dans FormsStudio :

  1. Double-cliquer sur l’entité Paramètres dans l’explorateur de module. Cette entité est positionnée en 4ème position après le nom du module.
  2. Sélectionner un type de paramètre dans la boîte à outils.
  3. Glisser-déposer le paramètre sélectionné dans la zone centrale d’édition.
    Il est possible de renommer un paramètre en modifiant sa propriété Nom.Pour assigner la valeur d’un paramètre :

    1. Se rendre dans le portail Administrateur d’Easily.
    2. Se rendre dans le menu Applications, menu Paramètres de module (sous Dossiers de spécialité).

    Il suffit ensuite de sélectionner le type de paramètre à assigner, le module dans lequel il a été créé, et enfin le paramètre. Cliquer sur le bouton + pour ajouter une nouvelle valeur. En fonction du type de paramètre ajouté, l’édition de la valeur est différente (saisie de texte long pour le type Texte, liste déroulante contenant les formulaires pour le type Sélection de formulaire, etc.).

15.2.3        Utilisation des paramètres

Génération dans le code distant

Chaque paramètre créé dans FormsStudio est généré en tant que propriété statique dans la classe C# du module. Pour accéder à cette propriété :

Forms.Modules.NOM_MODULE.NOM_PARAMETRE

Paramètre de type Texte

Pour récupérer la valeur d’un paramètre de type Texte dans le code distant, utiliser la méthode GetTextModuleParameterValue disponible dans le service DominhoService de la propriété ModuleAPI :

var value = ModuleAPI.DominhoService.GetTextModuleParameterValue( Formation.Module_Formation.ExempleParametreTexte);

Il est nécessaire de passer la propriété statique du paramètre dans la fonction pour récupérer sa valeur.

Il est de plus possible d’assigner la valeur d’un paramètre de type Texte dans le code distant (en plus de l’assignation classique via le portail Administrateur). Pour cela, utiliser la méthode SetTextModuleParameterValue disponible dans le service DominhoService de la propriété ModuleAPI :

ModuleAPI.DominhoService.SetTextModuleParameterValue(Formation.Module_Formation.ExempleParametreTexte, “Valeur texte”);

Paramètre de type Fichier

Pour récupérer la valeur d’un paramètre de type Fichier dans le code distant, utiliser la méthode GetFileModuleParameterValue disponible dans le service DominhoService de la propriété ModuleAPI :

var file =          Module.API.DominhoService.GetFileModuleParameterValue( Formation.Module_Formation.ExempleParametreFichier);

La valeur retournée correspond à un tableau de byte. Il est alors possible d’utiliser ce fichier pour qu’il soit téléchargé par l’utilisateur à la fin de la fonction distante via l’IExecutionContext passé dans chaque méthode distante :

var file = ModuleAPI.DominhoService.GetFileModuleParameterValue(     Formation.Module_Formation.ExempleParametreFichier);

 

Pour plus d’informations sur l’IExecutionContext, consulter le chapitre [15.5].

Il est aussi possible de proposer à l’utilisateur de télécharger le fichier via l’utilisation de l’instruction Ouvrir un fichier ressource.

Enfin, un paramètre de type Fichier peut aussi être utilisé dans le contrôle de la vue Mémo. Ce contrôle, présenté sous la forme d’un icone d’infobulle, permet de télécharger le fichier associé lorsque l’utilisateur clique dessus.

Paramètre de type Sélection de formulaire

Il est possible de requêter des formulaires sélection paramétrés dans des paramètres de module. Pour plus d’informations, consulter le chapitre [14.3.3].

Was this article helpful?

Related Articles

Poster un commentaire

Vous devez être connecté pour pouvoir poster un commentaire.