生成ページのページ メソッド

dataApi オブジェクトのページ メソッドを使用して、ページがダイアログとして使用されるときに値を返すなど、生成ページ自体を制御します。 現時点では、ページ メソッドは 1 つだけです。

setPageOutput メソッド

ダイアログが閉じたときに生成ページを開いたときに呼び出し元スクリプトに返される値を設定します。 このメソッドは、生成ページ ダイアログからの値の返しをサポートするホストでのみ使用できます。 これは共有 dataApi コントラクトの一部ではないので、呼び出す前に存在することを確認してください。

Parameters

Name タイプ Description
value 不明 ダイアログを開いたスクリプトに返す値。 値には、プリミティブ、オブジェクト、または配列を指定できます。

Returns

値なし。

setPageOutput の例

dataApi.setPageOutput?.({
    action: "selected",
    recordId: selectedRecordId
});

const xrm = (window as any).Xrm;
await xrm.Navigation.navigateBack();

setPageOutputを呼び出しても、ダイアログが閉じたり、呼び出し元ページが更新されたりすることはありません。 Xrm.Navigation.navigateBack()を使用してダイアログを閉じます。 Xrm.Navigation.navigateToによって返される promise は、returnValue プロパティに最後に格納された値が含まれるオブジェクトで解決されます。 呼び出し元のスクリプトは、返された値をフォーム、グリッド、またはその他の状態に明示的に適用する必要があります。

このメソッドは、ダイアログとして開かれた生成ページに適用されます。 インラインまたはアプリのサイド ウィンドウで開かれた生成ページは、呼び出し元のスクリプトに値を返しません。

  • 最終更新: