Microsoft Dynamics 365 データをページからパラメーターとしてリボン操作に渡す
公開日: 2017年1月
対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online
操作をリボン上に定義する場合、ページからデータを JavaScript 関数または URL に渡す処理が頻繁に必要とされます。 ここでは、<CrmParameter> (RibbonDiffXml) 要素を使用してこれらの値を取得するためのオプションについて説明します。
グリッド値
<CrmParameter> (RibbonDiffXml) 要素で使用可能な値の大半は、グリッドまたは階層グラフで表示されるデータを操作するためのものです。Value 属性列挙オプションを使用すると、次のアイテムからアイテムを簡単に切り分けることができます。
選択されているアイテム
SelectedControlSelectedItemCount
SelectedControlSelectedItemIds
SelectedControlSelectedItemReferences
すべての項目
SelectedControlAllItemCount
SelectedControlAllItemIds
SelectedControlAllItemReferences
選択されていないアイテム
SelectedControlUnselectedItemCount
SelectedControlUnselectedItemIds
SelectedControlUnselectedItemReferences
これらのグループ分けごとに、アイテムの数や GUID 識別子を収集できます。 値を URL に渡している場合は、グリッド内のオブジェクトを一意に識別するために必要なすべての情報を格納した EntityReference オブジェクトも取得できます。 これらのパラメーターは、表示中のページがメイン グリッド (HomepageGrid) である場合とフォーム内のサブグリッドである場合のどちらにも適用されます。SelectedEntityTypeName パラメーターと組み合わせて使用すると、別のアプリケーションに渡す必要がある情報がすべて入手できます。
フォーム値
フォーム リボンに対しては、Xrm.Page.data.entity.属性 コレクションと Xrm.Page.ui.controls コレクションを使用して、既知のフィールドから値を取得できます。 ただし、選択されているフォーム フィールドの値を渡す場合は、この値を取得するためにコードを追加する必要があります。
PrimaryControlIdPrimaryControlId パラメーターを使用すると、リボン コントロールにフォーカスが移動したときにそのコントロールの Id 値を取得できます。 この Id は、ドキュメント オブジェクト モデル (DOM) の Id 値です。 データ値を取得するには、次の例に示すようなコードを使用して値の取得を試みる必要があります。
var focusFieldValue = Xrm.Page.ui.controls.get(PrimaryControlId).getAttribute().getValue()
コンテキスト情報
データ値のほかに、<CrmParameter> (RibbonDiffXml) を使用して追加のコンテキスト情報を取得できます。
利便性を向上するため、Xrm.Page.context を使用して getOrgUniqueName、getOrgLcid、または getUserId メソッドを使用しなくても、Value 属性オプションの OrgName、OrgLcid、および UserLcid を使用できます。<Url> (RibbonDiffXml) 操作を行う場合は、PassParams 属性を使用してコンテキスト情報を含めることもできます。
Value オプションの PrimaryEntityTypeName と FirstPrimaryItemId は、エンティティ レコードの情報を提供します。PrimaryItemIds リボンの HomepageGrid を使用して、すべての表示中アイテムのリストを取得できます。
また、CommandProperties 値を使用して、リボン コントロールからイベントの詳細情報を渡すことができます。 この機能を使用するとコンテキスト情報を中央機能に送信できるので、中央機能はイベントのコンテキストに基づいて、実行する操作を決めることができます。
関連項目
コマンドおよびリボンをカスタマイズする
リボンの使用による URL へのパラメーターの受け渡し
<CrmParameter> (RibbonDiffXml)
<JavaScriptFunction> (RibbonDiffXml)
<Url> (RibbonDiffXml)
リボン アクションの定義
ユーザー定義のアクションによるリボンの変更
Microsoft Dynamics 365
© 2017 Microsoft. All rights reserved. 著作権