Microsoft Dynamics 365 で利用できるリボン

公開日: 2017年1月

対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online

このトピックでは、Microsoft Dynamics 365 (オンラインおよび設置型) でリボンを定義および変更する場所について説明します。

このトピックの内容

リボン定義

エンティティ リボン

基本ホーム タブ

Microsoft Office Outlook リボン用 Microsoft Dynamics Dynamics 365

その他のリボン

カスタム ページのリボン

リボン定義

Microsoft Dynamics 365 には、アプリケーションのすべてのリボンに対する既定の <RibbonDiffXml> (RibbonDiffXml) 定義が含まれています。 組織のリボンを定義している現在の XML をエクスポートおよび表示することはできますが、XML を直接更新することはできません。 リボンをカスタマイズするには、リボンをどのように変更するかを定義します。 指定した変更定義は、リボンがアプリケーションに表示される際に適用されます。 すべての変更は、<CustomAction> (RibbonDiffXml) 要素または <HideCustomAction> (RibbonDiffXml) に含めます。 これらの要素は、Microsoft Dynamics 365 (オンラインおよび設置型) が提供する既定のリボン定義よりも優先して適用されます。

変更定義を記述する場合は、既定のリボンの定義を頻繁に参照する必要があります。 たとえば、特定のリボン要素を非表示にする場合は、その要素の一意の ID を知る必要があります。 新しいリボン要素を既存のリボン要素の中または横に配置する場合は、それらの要素の ID 値と、要素の相対位置を制御するシーケンス順序を知る必要があります。

このように、既存のリボン要素の定義を参照する必要があるため、組織の現在のリボン定義を理解することは非常に重要です。 リボンの現在の状態を表す XML ファイルのエクスポートに使用できるメッセージは 2 つあります。 これらの定義には、既にシステムに適用されているすべてのカスタマイズが含まれているので、以前適用されたすべてのユーザー定義リボンをカスタマイズできます。 詳細については、「リボン定義のエクスポート」を参照してください。

すぐに使えるよう、既定のリボン定義は、ダウンロード可能ファイルとして Microsoft Dynamics 365 SDK に含まれています。SDK\Resources\ExportedRibbonXml フォルダーには、カスタマイズされていないリボンを持つ組織用の出力ファイルが含まれています。 このデータをエクスポートするために、サンプル アプリケーションを実行する必要はありません。 リボンがカスタマイズされている場合は、サンプル アプリケーションを実行して、このフォルダーのファイルをこれまで組織に適用されたすべてのカスタマイズで更新する必要があります。

エクスポートされたリボン XML ファイルの中で、applicationRibbon.xml ファイルには、特定のエンティティに対して定義されていないすべてのリボンが含まれます。 これらのリボンは、アプリケーション リボン ソリューション コンポーネントに対応しています。 エンティティごとに、エンティティ名ribbon.xml ファイルがあります。 このファイルは、各エンティティに含まれる RibbonDiffXml に対応しています。 特定のエンティティのリボンを編集する場合は、そのエンティティのリボン XML ファイルを見つける必要があります。

エンティティ リボン

すべてのエンティティで、エンティティ リボン テンプレートと呼ばれる共通のリボン定義が使用されます。 エンティティ リボン テンプレート定義は、applicationribbon.xml ファイル内にあります。 ユーザー定義エンティティを作成した場合、表示されるリボンは、エンティティ リボン テンプレートによって定義された既定のリボンです。 各システム エンティティには、エンティティ リボン テンプレート定義に基づいて作成された個々の <RibbonDiffXml> (RibbonDiffXml) 定義があります。

applicationribbon.xml ファイル内には、すべてのエンティティに適用される以下のタブがあります。

• Mscrm.Form.{!EntityLogicalName}.MainTab

  エンティティの表示名をラベルに表示するタブ。

• Mscrm.Form.{!EntityLogicalName}.Related

  [追加] というラベルを持つタブ。

• Mscrm.Form.{!EntityLogicalName}.Developer

  [カスタマイズ] というラベルを持つタブ。

• Mscrm.HomepageGrid.{!EntityLogicalName}.MainTab

  エンティティの複数形での表示名をラベルに表示するタブ。

• Mscrm.HomepageGrid.{!EntityLogicalName}.View

  [表示] というラベルを持つタブ。

• Mscrm.HomepageGrid.{!EntityLogicalName}.Related

  [追加] というラベルを持つタブ。

• Mscrm.HomepageGrid.{!EntityLogicalName}.Developer

  [カスタマイズ] というラベルを持つタブ。

• Mscrm.SubGrid.{!EntityLogicalName}.ContextualTabs

  フォームまたはグラフのサブ グリッドにフォーカスがある場合は、[リスト ツール]というラベルを持つ状況依存のタブが表示されます。

  • Mscrm.SubGrid.{!EntityLogicalName}.MainTab

    エンティティの複数形での表示名を表示するタブ。

特定のエンティティのリボン定義を表示すると、通常は、エンティティの名前が {!EntityLogicalName}トークンに置き換わることがわかります。 特定のエンティティのリボン定義で、{!EntityLogicalName} トークンを表示すると、それは、そのエンティティに対する特定の定義はなく、単にエンティティ リボン テンプレートの定義を使用することを意味します。 特定のエンティティにリボンを定義した場合は、常に実際のエンティティ名が使用されます。 特定のエンティティのリボンの変更は、//ImportExportXml/Entities/Entity/RibbonDiffXml ノードで定義する必要があります。

RibbonDiffXml ノードでエンティティの論理名の代わりにトークン {!EntityLogicalName} を代用するアプリケーション リボンへの変更を定義することで、すべてのエンティティに適用する変更を行うことができます。 すべてのエンティティに対して定義されているアプリケーション リボンへの変更は、ImportExportXml/RibbonDiffXml ノードで定義する必要があります。 特定のエンティティの RibbonDiffXml ノードで定義することはできません。

グリッド リボン

エンティティ グリッド リボンは、Mscrm.HomepageGrid.<entity logical name> で始まる ID 属性値を持つタブのコレクションです。 たとえば、取引先企業エンティティ グリッドに「Accounts」というテキストを持つタブは Mscrm.HomepageGrid.account.MainTab です。 取引先企業エンティティ グリッドに表示されるすべてのタブは、Mscrm.HomepageGrid.account で始まる ID 値を持ちます。

サブグリッド リボン

エンティティ サブグリッド リボンは、Mscrm.SubGrid.<entity logical name> で始まる ID 属性値を持つタブのコレクションで構成される状況依存グループです。 たとえば、取引先企業エンティティ サブグリッドに「Accounts」というテキストを持つタブは Mscrm.SubGrid.account.MainTab です。

エンティティのレコードのリストが別のエンティティのフォームまたはグラフのサブグリッド内に表示される場合、サブグリッドの上部または内で直接使用できるコントロールは 3 種類のみです。 これらのコントロールの動作は、関連付けられているコマンドの変更で、変更できます。

• 追加アイコンを含むコマンドの既定動作は、 サブグリッドのレコードが現在のレコードに関連しているかどうかによって異なります。

  レコードが現在のレコードに関連する場合、既定動作では既存レコードを探します。 既存のレコードを検索できない場合、またはユーザーが新しいレコードを作成するときには、[新規追加] をクリックできます。

  レコードが現在のレコードに関連していない場合、既定動作では新しいレコードを追加します。 エンティティに簡易作成フォームがある場合、これが表示されますが、他の場合には、新しい完全なフォームが表示されます。

  活動は、このパターンに対する例外です。 追加コマンドでは常に、活動のタイプが最初にプロンプトされます。

• リストの表示アイコンを含むコマンドが使用できるすべてコマンドが使用できる全一覧をオープンします。

  サブグリッドが現在のレコードに関連付けられている場合、このコマンドの既定動作は、関連ビューをオープンすることです。

  サブグリッドが現在のレコードに関連付けられていない場合、このコマンドの既定動作は、メインリストビューのビューをオープンすることです。

• 削除アイコンが、 ユーザーがリストのレコードにカーソルを置くと、行の右側に表示されます。

  1:N の関連付けのレコードまたは関連付けがないレコードの場合、既定動作はレコードを削除することです。 関係構成のために許可されていない場合、削除はブロックされている可能性があります。 オープンしている活動および請求書は、関連構成のために削除されない可能性があるレコードで共通の例です。

  N:N の関連付けを示す関連付けの場合、既定動作は、レコード自体ではなく、レコードをつなぐ関連付けを削除することです。

<CommandDefinition> (RibbonDiffXml)を使用してコマンドに関連付けられたアクションを変更することで、既定動作を変更できますが、コマンドの名前を変更することはできません。 たとえば、削除動作は、レコードを削除するのではなくレコードを非アクティブ化するように変更することはできます。

これらのコマンドに対して表示されるアイコンを変更することはできません。<HideCustomAction> (RibbonDiffXml)を使用して、これらのコマンドを非表示にすることができます。

フォーム リボン

エンティティごとに複数のフォームを持つことができます。 エンティティ レベルでの定義を追加することにより、そのエンティティのすべてのフォームに対するフォーム リボンへの変更を定義できます (//ImportExportXml/Entities/Entity/RibbonDiffXml)。

エンティティ フォームごとに固有のリボン定義を持つことができます。 エクスポートした customizations.xml ファイル内の //ImportExportXml/Entities/Entity/FormXml/forms/systemform/form/RibbonDiffXml の場所に、変更した <RibbonDiffXml> (FormXml) を追加する必要があります。

エンティティ フォーム リボンは、Mscrm.Form.<entity logical name> で始まる ID 属性値を持つタブのコレクションです。 たとえば、取引先企業エンティティ フォームに**[Account]**というラベルを持つタブは Mscrm.Form.account.MainTab です。 取引先企業エンティティ フォームに表示されるすべてのタブは、Mscrm.Form.account で始まる ID 値を持ちます。

基本ホーム タブ

基本ホーム タブは、特定のページにタブを表示しないエンティティ コンテキストまたは表示規則によって代替タブが定義されていない場合、常にメインのアプリケーション リボンに表示されます。 たとえば、Microsoft Dynamics 365ヘルプを表示すると、このタブが表示されます。 基本ホーム タブの ID は、Mscrm.BasicHomeTab です。

Microsoft Office Outlook リボン用 Microsoft Dynamics Dynamics 365

Microsoft Office Outlook 2007 にはリボンが表示されません。Microsoft Office Outlook 2010 はリボンを使用します。Microsoft Dynamics 365 リボン定義を使用して、これらすべてにコントロールを追加できます。

Microsoft Office Outlook 2007

古いバージョンの Outlook 用 Microsoft Dynamics 365 のツールバーとメニューをサポートする Microsoft Office Outlook コントロールは、それぞれ Mscrm.LegacyOfficeToolbar および Mscrm.LegacyOfficeMenubar という ID 値を持つタブとして定義されます。

Microsoft Office Outlook 2010

Outlook 用 Microsoft Dynamics 365 のツールバーとメニューをサポートする Microsoft Office Outlook 2010 コントロールは、それぞれ Mscrm.Outlook14GlobalToolbar および Mscrm.Outlook14GlobalMenubar という ID 値を持つタブとして定義されます。

その他のリボン

他に、特別な目的のリボン タブが複数と状況依存グループが 1 つ、Microsoft Dynamics 365 によって定義されています。 各タブは、いつ表示されるかを制御する固有の <TabDisplayRule> (RibbonDiffXml) と関連付けられています。 使用できるタブを次の表に示します。

カスタム ページのリボン

サイトマップを使用して、アプリケーション ナビゲーション内にカスタム ページを表示できます。 これらのページには、常に 基本ホーム タブ (Mscrm.BasicHomeTab) が表示されます。<PageRule> (RibbonDiffXml) を使用して、カスタム ページ上のカスタム リボン コンポーネントを有効化または表示することはできません。

関連項目

コマンドおよびリボンをカスタマイズする
バーまたはリボンの表示

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権