HTML フォームと吹き出しの API

以下の表は、カスタム HTML フォームと吹き出しを構築するときに使用できる UiPath 固有の API の概要を示しています。これらの API は、HTML フォーム内でスタンドアロンとして使用してフォームのサイズを変更したり、Studio に送り返すメッセージとして使用してトリガー ワークフローの実行を継続したりできます。これらの API は JavaScript として記述されています。

フォームと吹き出し

以下の表は、HTML でフォームと吹き出しの両方を構築するときに使用できる API を示しています。API はイベント リスナーとして機能し、コールバック関数 e をトリガーできます。このコールバック関数は、後でフォームや吹き出しの他のプロパティ (高さ、幅、上など) を設定するために使用できます。また、フォームの [検証] をクリックして、プロパティをコンソールに直接書き込むことで、他のプロパティをテストすることもできます。

また、API を使用してフォームの値の取得と設定、フォーム イベントのトリガーを行うこともできます。

API	説明	JavaScript の例
uiPath.form.isVisible	フォームが現在画面に表示されているかどうかを確認します。フォームが表示されているか、それとも非表示かを示す Boolean 値を返します。	if (uiPath.form.isVisible === true){ console.log("The form is visible"); } else { console.log("The form is not visible"); }
uiPathApi.form.addEventListener("visibilityChanged", (e) => {})	フォームの表示/非表示のステータスの変更を検出するイベント リスナーを設定します。フォームの表示/非表示が変更されると、指定されたコールバック関数が実行されます。これにより、フォームが表示されるようになったとき、または表示されなくなったときにアクションや更新を実行できるようになります。コールバック関数の e パラメーターはイベントを表し、ユーザーは表示/非表示のステータスがどのように変更されたかを判断するためのプロパティを指定できます (例: e.detail)。	uiPathApi.form.addEventListener("visibilityChanged", (e) => { console.log("form visibility changed triggered: " + e.detail); });
uiPathApi.form.addEventListener("locationChanged", (e) => {})	フォームの位置の変更に応答するイベント リスナーを設定します。フォームの場所が変更されると、指定されたコールバック関数が実行されます。コールバック関数内では、イベントを表す e パラメーターを指定できます。このイベント オブジェクトには、場所の変更に関する情報が含まれます。たとえば、フォームの左 (e.detail.left) や上 (e.detail.top) などの別の座標に移動した場合です。	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)	フォームの値を取得できます。	getValue: function (elementId) { if (elementId == 'getArray') { return [1, 2, 3]; }
setValue: function (elementId, value)	フォームの値を設定できます。	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)	[終了] などのフォーム イベントをトリガーできます。[フォーム トリガー アクティビティ] 内では、この API を使用して作成したフォーム イベントは、フォーム メッセージ イベントとしてのみアクセスできます。	sendMessage: function (id, value) { }

吹き出し

以下の表は、HTML で吹き出しを構築するときに使用できる API を示しています。これらの API を使用すると、吹き出しがバインドされるターゲット要素に関する詳細を抽出できます。API はイベント リスナーとして機能し、コールバック関数 e をトリガーします。このコールバック関数は、後でターゲットの他のプロパティ (高さ、幅、上など) を設定するために使用できます。また、吹き出しの [検証] をクリックして、プロパティをコンソールに直接書き込むことで、他のプロパティをテストすることもできます。

API	説明	JavaScript の例
uiPathApi.target.visibile	吹き出しに関連付けられているターゲット要素が現在画面に表示されているかどうかを確認します。要素が表示されているか、それとも非表示かを示す Boolean 値を返します。	if (uiPath.target.isVisible === true){ console.log("The target is visible"); } else { console.log("The target is not visible"); }
uiPathApi.target.addEventListener("visibilityChanged", (e) => {})	ターゲット要素の表示/非表示の変更に関するイベント リスナーを設定します。要素の表示/非表示が変更されると、指定されたコールバック関数が実行されます。その後、コールバック関数を使用してターゲットの表示/非表示に関する詳細を取得し、ターゲットの表示/非表示の変更回数を追跡するためのカウンターを設定できます。	uiPathApi.target.addEventListener("visibilityChanged", (e) => { console.log("target visibility changed triggered: " + e.detail); window.targetVisibilityChangedArg = e.detail; window.targetVisibilityChangedCount++; });
uiPathApi.target.addEventListener("locationChanged", (e) => {})	ターゲット要素の位置 (左または上) の変更に応答するイベント リスナーを設定します。要素の位置が変わると、指定されたコールバック関数が実行されます。その後、コールバック関数を使用してターゲットの現在の場所に関する詳細を取得し、カウンターを設定して場所の変更回数を把握することができます。	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) => {})	ターゲット要素のサイズ (幅または高さ) の変更を検出するイベント リスナーを設定します。要素のサイズが変更されると、指定されたコールバック関数が実行されます。その後、ターゲット要素の幅と高さを取得し、ターゲットのサイズの変更回数を追跡するためのカウンターを設定できます。	uiPathApi.target.addEventListener("sizeChanged", (e) => { window.targetSizeChangedArg = e.detail.width + " " + e.detail.height; window.targetSizeChangedCount++; console.log("target size changed triggered: " + window.targetSizeChangedArg);