API pour les formulaires HTML et les légendes

Le tableau ci-dessous présente les API spécifiques à UiPath qui peuvent être utilisées lors de la création de formulaires et de légendes HTML personnalisés. Ces API peuvent être utilisées de manière autonome dans des formulaires HTML, générant le redimensionnement d'un formulaire, ou elles peuvent être utilisées comme messages à renvoyer dans Studio, afin que vos workflows de déclencheur puissent continuer à s'exécuter. Ces API sont écrites en JavaScript.

Formulaires et légendes

Le tableau ci-dessous répertorie les API que vous pouvez utiliser lors de la création de formulaires et de légendes en HTML. Les API peuvent agir comme des auditeurs d'événements et déclencher une fonction de rappel e, que vous pouvez utiliser ultérieurement pour accéder à d'autres propriétés du formulaire ou de la légende, telles que la hauteur, la largeur ou le haut. Vous pouvez également tester d'autres propriétés en appuyant sur inspecter sur le formulaire, puis en écrivant les propriétés directement dans la console.

Vous pouvez également utiliser des API pour obtenir et définir des valeurs de formulaire et déclencher des événements de formulaire.

API	Description	Exemple JavaScript
uiPath.form.isVisible	Vérifiez si le formulaire est actuellement visible à l'écran. Elle renvoie une valeur booléenne indiquant si le formulaire est visible ou masqué.	if (uiPath.form.isVisible === true){ console.log("The form is visible"); } else { console.log("The form is not visible"); }
uiPathApi.form.addEventListener("visibilityChanged", (e) => {})	Configurez un écouteur d'événement pour détecter les changements dans le statut de visibilité d'un formulaire. Lorsque la visibilité du formulaire change, la fonction de rappel spécifiée est exécutée. Cela offre la possibilité d’effectuer des actions ou des mises à jour en réponse au formulaire qui devient visible ou masqué. Le paramètre e de la fonction de rappel représente l'événement, et vous pouvez accéder à ses propriétés pour déterminer le nouveau statut de visibilité, tel que e.detail.	uiPathApi.form.addEventListener("visibilityChanged", (e) => { console.log("form visibility changed triggered: " + e.detail); });
uiPathApi.form.addEventListener("locationChanged", (e) => {})	Configurez un écouteur d'événement qui répond aux changements de position d'un formulaire. Lorsque l'emplacement du formulaire change, la fonction de rappel fournie est exécutée. Dans la fonction de rappel, vous avez accès au paramètre e , qui représente l'événement. Cet objet d'événement contient des informations sur le changement d'emplacement, telles que les nouvelles coordonnées gauche (e.detail.left) et haut (e.detail.top) du formulaire.	uiPathApi.form.addEventListener("locationChanged", (e) => { window.formLocationChangedArg = e.detail.left + " " + e.detail.top; window.formLocationChangedCount++; console.log("form location changed triggered: " + window.formLocationChangedArg); });
getValue: function (elementId)	Permet de récupérer les valeurs du formulaire.	getValue: function (elementId) { if (elementId == 'getArray') { return [1, 2, 3]; }
setValue: function (elementId, value)	Vous permet de définir des valeurs de formulaire.	setValue: function (elementId, value) { // execute this to throw in case the form element does not exist $("#" + elementId).val().toString(); $("#" + elementId).val(value); },
sendMessage: function (id, value)	Permet de déclencher un événement de formulaire, tel que Closed. Dans l' activité du déclencheur de formulaire, tout événement de formulaire que vous créez à l'aide de cette API n'est accessible qu'en tant qu'événement de message de formulaire .	sendMessage: function (id, value) { }

Légendes

Le tableau ci-dessous répertorie les API que vous pouvez utiliser lors de la création de légendes en HTML. Ces API vous permettent d'extraire des détails sur l'élément cible auquel la légende est liée. Les API agissent comme des auditeurs d'événements et déclenchent une fonction de rappel e, que vous pouvez utiliser ultérieurement pour accéder à d'autres propriétés de la cible, telles que la hauteur, la largeur, le haut. Vous pouvez également tester d'autres propriétés en appuyant sur inspecter sur la légende, puis en écrivant les propriétés directement dans la console.

API	Description	Exemple JavaScript
uiPathApi.target.visibile	Vérifiez si l'élément cible associé à une légende est actuellement visible à l'écran. Elle renvoie une valeur booléenne indiquant si l'élément est visible ou masqué.	if (uiPath.target.isVisible === true){ console.log("The target is visible"); } else { console.log("The target is not visible"); }
uiPathApi.target.addEventListener("visibilityChanged", (e) => {})	Configurez un écouteur d'événement pour les modifications de la visibilité de l'élément cible. Lorsque la visibilité de l’élément change, la fonction de rappel spécifiée est exécutée. Vous pouvez ensuite obtenir les détails sur la visibilité de la cible à l'aide de la fonction de rappel et configurer un compteur pour suivre combien de fois la visibilité de la cible a changé.	uiPathApi.target.addEventListener("visibilityChanged", (e) => { console.log("target visibility changed triggered: " + e.detail); window.targetVisibilityChangedArg = e.detail; window.targetVisibilityChangedCount++; });
uiPathApi.target.addEventListener("locationChanged", (e) => {})	Configurez un écouteur d'événement qui répond aux changements de position (à gauche ou en haut) de l'élément cible. Lorsque la position de l'élément change, la fonction de rappel fournie est exécutée. Vous pouvez ensuite obtenir les détails sur l'emplacement actuel de la cible à l'aide de la fonction de rappel et configurer un compteur pour celle-ci afin que vous sachiez combien de fois l'emplacement a changé.	uiPathApi.target.addEventListener("locationChanged", (e) => { window.targetLocationChangedArg = e.detail.left + " " + e.detail.top; window.targetLocationChangedCount++; console.log("target location changed triggered: " + window.targetLocationChangedArg); });
uiPathApi.target.addEventListener("sizeChanged", (e) => {})	Configurez un écouteur d'événement pour détecter les changements de taille (largeur ou hauteur) de l'élément cible. Lorsque la taille de l’élément change, la fonction de rappel spécifiée est exécutée. Vous pouvez ensuite obtenir la largeur et la hauteur de l'élément cible et configurer un compteur pour suivre combien de fois la taille de la cible a changé.	uiPathApi.target.addEventListener("sizeChanged", (e) => { window.targetSizeChangedArg = e.detail.width + " " + e.detail.height; window.targetSizeChangedCount++; console.log("target size changed triggered: " + window.targetSizeChangedArg);