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

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

構文

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

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

パラメーター

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

pageInput パラメーター

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

エンティティ リスト

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

エンティティ レコード

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

関係オブジェクト

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

ダッシュボード

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

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

HTML Web リソース

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

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

カスタム ページ

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

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

生成ページ

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

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

navigationOptions パラメーター

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

戻り値

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

• インライン: Promise はすぐに解決され、値は返されません。

• dialog: Promise はダイアログが閉じると解決されます。 pageType = entityRecord で、作成モードでフォームを開いたときにのみ、オブジェクトは渡されます。 オブジェクトには、作成されるテーブル レコードを識別するための以下のプロパティと共に 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
    }
);

関連記事

Xrm.Navigation
カスタムページへの移動とカスタムページからの移動 (プレビュー)