APIs für HTML-Formulare und Pop-ups

In der folgenden Tabelle sind die UiPath-spezifischen APIs aufgeführt, die beim Erstellen benutzerdefinierter HTML-Formulare und Popups verwendet werden können. Diese APIs können einzeln in HTML-Formularen verwendet werden, um die Größe eines Formulars zu ändern, oder sie können als Nachrichten verwendet werden, die zurück an Studio gesendet werden, damit Ihre Trigger-Workflows weiterhin ausgeführt werden können. Diese APIs sind als JavaScript geschrieben.

Formulare und Popups

Die folgende Tabelle zeigt die APIs, die Sie beim Erstellen von Formularen und Popups in HTML verwenden können. Die APIs können als Ereignis-Listener fungieren und eine Rückruffunktion e auslösen, mit der Sie später auf andere Eigenschaften des Formulars oder Popups zugreifen können, z. B. Höhe, Breite oder oben. Sie können auch andere Eigenschaften testen, indem Sie im Formular „Überprüfen“ drücken und die Eigenschaften dann direkt in die Konsole schreiben.

Sie können APIs auch verwenden, um Formularwerte abzurufen und festzulegen und Formularereignisse auszulösen.

API	Beschreibung	JavaScript-Beispiel
uiPath.form.isVisible	Überprüfen Sie, ob das Formular derzeit auf dem Bildschirm sichtbar ist. Sie gibt einen booleschen Wert zurück, der angibt, ob das Formular sichtbar oder ausgeblendet ist.	if (uiPath.form.isVisible === true){ console.log("The form is visible"); } else { console.log("The form is not visible"); }
uiPathApi.form.addEventListener("visibilityChanged", (e) => {})	Richten Sie einen Ereignis-Listener ein, um Änderungen am Sichtbarkeitsstatus eines Formulars zu erkennen. Wenn sich die Sichtbarkeit des Formulars ändert, wird die angegebene Rückruffunktion ausgeführt. Dies bietet die Möglichkeit, Aktionen oder Aktualisierungen als Reaktion darauf auszuführen, ob das Formular sichtbar oder ausgeblendet wird. Der Parameter e in der Rückruffunktion stellt das Ereignis dar, und Sie können auf seine Eigenschaften zugreifen, um den neuen Sichtbarkeitsstatus zu bestimmen, z. B. e.detail.	uiPathApi.form.addEventListener("visibilityChanged", (e) => { console.log("form visibility changed triggered: " + e.detail); });
uiPathApi.form.addEventListener("locationChanged", (e) => {})	Richten Sie einen Ereignis-Listener ein, der auf Änderungen der Position eines Formulars reagiert. Wenn sich der Speicherort des Formulars ändert, wird die bereitgestellte Rückruffunktion ausgeführt. Innerhalb der Rückruffunktion haben Sie Zugriff auf den Parameter e , der das Ereignis darstellt. Dieses Ereignisobjekt enthält Informationen über die Änderung des Speicherorts, z. B. die neuen linken (e.detail.left) und oberen Koordinaten (e.detail.top) des Formulars.	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)	Ermöglicht das Abrufen von Formularwerten.	getValue: function (elementId) { if (elementId == 'getArray') { return [1, 2, 3]; }
setValue: function (elementId, value)	Ermöglicht das Festlegen von Formularwerten.	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)	Ermöglicht es Ihnen, ein Formularereignis auszulösen, z. B. Geschlossen. Innerhalb der Aktivität Formulartrigger kann auf jedes Formularereignis, das Sie mit dieser API erstellen, nur als Formularmeldungsereignis zugegriffen werden.	sendMessage: function (id, value) { }

Popups

Die folgende Tabelle zeigt die APIs, die Sie beim Erstellen von Popups in HTML verwenden können. Mit diesen APIs können Sie Details über das Zielelement extrahieren, an das das Popup gebunden wird. Die APIs fungieren als Ereignis-Listener und lösen eine Rückruffunktion e aus, mit der Sie später auf andere Eigenschaften des Ziels zugreifen können, z. B. Höhe, Breite, oben. Sie können auch andere Eigenschaften testen, indem Sie „Überprüfen“ im Popup drücken und die Eigenschaften direkt in der Konsole schreiben.

API	Beschreibung	JavaScript-Beispiel
uiPathApi.target.visibile	Überprüfen Sie, ob das einem Popup zugeordnete Zielelement derzeit auf dem Bildschirm sichtbar ist. Sie gibt einen booleschen Wert zurück, der angibt, ob das Element sichtbar oder ausgeblendet ist.	if (uiPath.target.isVisible === true){ console.log("The target is visible"); } else { console.log("The target is not visible"); }
uiPathApi.target.addEventListener("visibilityChanged", (e) => {})	Richten Sie einen Ereignis-Listener für Änderungen der Sichtbarkeit des Zielelements ein. Wenn sich die Sichtbarkeit des Elements ändert, wird die angegebene Rückruffunktion ausgeführt. Sie können dann die Details zur Sichtbarkeit des Ziels mithilfe der Rückruffunktion abrufen und einen Zähler konfigurieren, um nachzuverfolgen, wie oft sich die Sichtbarkeit des Ziels geändert hat.	uiPathApi.target.addEventListener("visibilityChanged", (e) => { console.log("target visibility changed triggered: " + e.detail); window.targetVisibilityChangedArg = e.detail; window.targetVisibilityChangedCount++; });
uiPathApi.target.addEventListener("locationChanged", (e) => {})	Richten Sie einen Ereignis-Listener ein, der auf Änderungen der Position (links oder oben) des Zielelements reagiert. Wenn sich die Position des Elements ändert, wird die bereitgestellte Rückruffunktion ausgeführt. Mit der Rückruffunktion können Sie dann die Details zum aktuellen Standort des Ziels abrufen und einen Zähler dafür konfigurieren, damit Sie wissen, wie oft sich der Standort geändert hat.	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) => {})	Richten Sie einen Ereignis-Listener ein, um Änderungen der Größe (Breite oder Höhe) des Zielelements zu erkennen. Wenn sich die Größe des Elements ändert, wird die angegebene Rückruffunktion ausgeführt. Sie können dann die Breite und Höhe des Zielelements abrufen und einen Zähler konfigurieren, um nachzuverfolgen, wie oft sich die Größe des Ziels geändert hat.	uiPathApi.target.addEventListener("sizeChanged", (e) => { window.targetSizeChangedArg = e.detail.width + " " + e.detail.height; window.targetSizeChangedCount++; console.log("target size changed triggered: " + window.targetSizeChangedArg);