navigateTo (クライアント API 参照)

指定されたテーブル リスト、テーブル レコード、HTML Web リソース、またはカスタム ページに移動します。

構文

Xrm.Navigation.navigateTo()を呼び出すには、次の構文を使用します。

Xrm.Navigation.navigateTo(pageInput,navigationOptions).then(successCallback,errorCallback);

Parameters

このメソッドは、次のパラメーターを受け入れます。

pageInput パラメーター

オブジェクト定義は、移動するページの種類 ( エンティティ リスト、 エンティティ レコード、 ダッシュボード、 HTML Web リソース、 カスタム ページ、 または生成ページ) に応じて変わります。

エンティティ リスト

エンティティ リスト オブジェクトには、次の値が含まれています。

エンティティ レコード

エンティティ レコード オブジェクトには、次の値が含まれています。

関係オブジェクト

関係オブジェクトは、エンティティ レコードで使用され、次の値が含まれます。

ダッシュボード

ダッシュボードを開く場合は、このオブジェクトを pageInput パラメーターとして使用 します。

ダッシュボード オブジェクトには、次の値が含まれています。

HTML Web リソース

pageInputを開く場合は、このオブジェクトを パラメーターとして使用します。

HTML Web リソースには、次の値が含まれています。

カスタム ページ

pageInputを開く場合は、このオブジェクトを パラメーターとして使用します。

カスタム ページ オブジェクトには、次の値が含まれています。

生成ページ

pageInputを開く場合は、このオブジェクトを パラメーターとして使用します。

recordId、entityName、またはdataを使用するには、入力パラメーターを受け入れるようにターゲット生成ページを設定する必要があります。

生成ページ オブジェクトには、次の値が含まれています。

クライアント API を使用して生成ページとの間を移動する方法を示す例を参照してください

navigationOptions パラメーター

navigationOptions オブジェクトには、次の値が含まれています。

戻り値

Promise を返します。 promise が解決されたときに渡される値は、ターゲットとページの種類によって異なります。

• インライン: Promise は、ナビゲーションが完了したときに解決され、値が返されません。
• ダイアログ: promise は、ダイアログが閉じると解決されます。
  • 作成モードで開かれたエンティティ レコードの場合、promise は savedEntityReference 配列を含むオブジェクトで解決されます。
  • 生成ページの場合、promise は、dataApi.setPageOutput(value)に最後に渡された値を含むreturnValue プロパティを持つオブジェクトで解決されます。 生成ページで出力値が設定されていない場合は、[ キャンセル ] または [閉じる] ボタンを選択してダイアログを閉じると、未定義の returnValueになります。
  • その他のページの種類では、ダイアログが閉じたときに値が返されません。

エンティティ レコードに対して返される savedEntityReference 配列には、次のプロパティが含まれています。

• entityType: テーブルの論理名。
• id: レコード GUID の文字列形式。
• name: レコードのプライマリ列の値。

例

次の例では、インラインおよびダイアログ内のさまざまなページの種類に移動する方法を示します。

例 1: アカウント リストを開く

メイン アカウント一覧をインラインで開きます。

var pageInput = {
    pageType: "entitylist",
    entityName: "account"
};
Xrm.Navigation.navigateTo(pageInput).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

例 2: ダイアログ内で既存のアカウント レコードを開く

ダイアログ内で既存のアカウント フォームを開きます。

var pageInput = {
    pageType: "entityrecord",
    entityName: "account",
    entityId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee" //replace with actual ID
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

例3: ダイアログ内の作成モードでアカウント フォームを開く

ダイアログ内の作成モードでアカウント フォームを開き、保存時に作成されたレコード参照を返します。

var pageInput = {
    pageType: "entityrecord",
    entityName: "account"    
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success(result) {
            console.log("Record created with ID: " + result.savedEntityReference[0].id + 
            " Name: " + result.savedEntityReference[0].name)
            // Handle dialog closed
    },
    function error() {
            // Handle errors
    }
);

例4: ダイアログで HTML Web リソースを開く

ダイアログで HTML Web リソースを開きます。

var pageInput = {
    pageType: "webresource",
    webresourceName: "new_sample_webresource.htm"
};
var navigationOptions = {
    target: 2,
    width: 500, // value specified in pixel
    height: 400, // value specified in pixel
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

例 5: ダイアログで入力パラメーターを含む生成ページを開く

レコード ID、エンティティ名、およびカスタム データ パラメーターを渡して、生成ページを中央揃えダイアログとして開きます。 これらのパラメーターを受け入れるように、生成ページを設定する必要があります。

var pageInput = {
    pageType: "generative",
    pageId: "<genPageID>", // replace with the ID of your generative page
    recordId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee", // replace with actual record GUID
    entityName: "account",
    data: { status: "active", category: "premium" }
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit: "%"},
    width: {value: 70, unit: "%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success(result) {
        const output = result?.returnValue;
        if (output) {
            console.log("Value returned by generative page:", output);
        }
    },
    function error(error) {
        console.log(error.message);
    }
);

関連記事

Xrm.Navigation
生成ページとの間を移動する
カスタムページへの移動とカスタムページからの移動 (プレビュー)