メインコンテンツまでスキップ

Form (폼) Widget Control

Formウィジェットをスクリプトから制御するときに使用するWidget Control（Property · Method · Event）の一覧です。ウィジェットの紹介と使い方はFormを参照してください。

備考

以下の例のformIDは、キャンバスでFormウィジェットに指定した名前（ID）です。スクリプトではwidgetID.memberの形式でアクセスします。

Widget Control一覧​

Widget Control種類シグネチャ説明
loadFormMethodformID.loadForm(formPath, linkArg)コンテナに表示するFormを読み込み、または差し替え
postMessageMethodformID.postMessage(name, data)内包しているFormのメッセージハンドラーへデータを送信

Property​

備考

該当なし — Formウィジェットにはスクリプト専用のPropertyがありません。スクリプトでは以下の共通Widget Control（getProperty / setProperty）で値を読み書きします。

Method​

loadForm​

コンテナに表示するFormを読み込みます。すでに表示中のFormがある場合は別のFormに差し替えます。同じFormがすでに読み込まれている場合や読み込み中の場合は、何も行いません。

  • 種類: Method
  • Parameters
    • formPath (string): 読み込むFormのID（パス）
    • linkArg: 読み込んだFormに渡すリンク引数（null可）
  • Returns: なし（戻り値なし）

Example

formID.loadForm("group/myForm", arg);

postMessage​

内包しているFormのonMessageハンドラーへメッセージを送信します。Formがまだ読み込み中の場合は、メッセージをキューに入れ、読み込みが完了してから渡します。

  • 種類: Method
  • Parameters
    • name (string): Formが待ち受けるメッセージ名
    • data: Formのメッセージハンドラーへ渡すデータ
  • Returns: なし（戻り値なし）

Example

formID.postMessage("refresh", { code: "005930" });

Event​

備考

該当なし — Formウィジェットには専用のEventがありません。

共通Widget Control（すべてのウィジェット）​

注記

すべてのウィジェットはsetProperty / getProperty / setStylePropertyのような名前ベースの共通Widget Control（Method）を使用できます。共通リファレンスドキュメント（作成予定）を参照してください。