Skip to content

Commit d7e2b16

Browse files
authored
Merge pull request MicrosoftDocs#3828 from MicrosoftDocs/Nava_issues
Adding info on global command bar
2 parents 4679293 + 2c1282a commit d7e2b16

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

powerapps-docs/developer/model-driven-apps/ribbons-available.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Ribbons available in model-driven apps | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3-
description: "The topic describes where ribbons are defined and modified" # 115-145 characters including spaces. This abstract displays in the search result.
3+
description: "The article describes where ribbons are defined and modified" # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
55
ms.date: 10/31/2018
66
ms.reviewer: ""
@@ -19,18 +19,18 @@ search.app:
1919

2020
<!-- https://docs.microsoft.com/dynamics365/customer-engagement/developer/customize-dev/ribbons-available-microsoft-dynamics-365 -->
2121

22-
This topic describes where ribbons are defined and modified in model-driven apps.
22+
This article describes where ribbons are defined and modified in model-driven apps.
2323

2424
<a name="ribbon_defs"></a>
2525

2626
## Ribbon definitions
2727

28-
Model-driven apps contains default `<RibbonDiffXml>` definitions for all ribbons in the application. You can export and view the current XML defining the ribbon for your organization, but you cannot update the XML directly. You customize the ribbon by defining how you want it to be changed. The change definitions that you specify are applied at runtime when the ribbon is displayed in the application.
28+
Model-driven apps contain default `<RibbonDiffXml>` definitions for all ribbons in the application. You can export and view the current XML defining the ribbon for your organization, but you cannot update the XML directly. You customize the ribbon by defining how you want it to be changed. The change definitions that you specify are applied at runtime when the ribbon is displayed in the application.
2929
All of your changes will be in the `<CustomAction>` or `<HideCustomAction>` elements. These elements are applied over the default ribbon definitions provided by model-driven apps.
3030

31-
When you write your change definitions, you will frequently need to reference the definitions of the default ribbons. For example, if you want to hide a specific ribbon element, you will need to know the unique Id of that element. If you want to position a new ribbon element within or next to an existing ribbon element, you will need to know the Id values for those elements, as well as the sequence order that will control the relative position of the elements.
31+
When you write your change definitions, you will frequently need to reference the definitions of the default ribbons. For example, if you want to hide a specific ribbon element, you will need to know the unique ID of that element. If you want to position a new ribbon element within or next to an existing ribbon element, you will need to know the ID values for those elements, as well as the sequence order that will control the relative position of the elements.
3232

33-
Because of this requirement to reference the definitions of existing ribbon elements, it is very important to understand the current ribbon definitions in your organization. There are two messages you can use to export XML files representing the current state of your ribbons. These definitions include any customizations that have already been applied to your system so that you can customize any custom ribbons that were previously applied. For more information, see [Export Ribbon Definitions](export-ribbon-definitions.md).
33+
Because of this requirement to reference the definitions of existing ribbon elements, it is important to understand the current ribbon definitions in your organization. There are two messages you can use to export XML files representing the current state of your ribbons. These definitions include any customizations that have already been applied to your system so that you can customize any custom ribbons that were previously applied. For more information, see [Export Ribbon Definitions](export-ribbon-definitions.md).
3434

3535
To help you get started, you can download the default ribbon definitions for model-driven apps from [Export Ribbon Definitions sample](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/orgsvc/C%23/ExportRibbonDefinitions). `The ExportedRibbonXml` file includes the output files you would have for an organization.
3636

@@ -86,17 +86,17 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
8686
You can make changes that apply to all entities by defining the changes to the application ribbons substituting the token `{!EntityLogicalName}` in place of an entity logical name in your RibbonDiffXml node. Changes to application ribbons that are defined for all entities must be defined in the `ImportExportXml/RibbonDiffXml` node. They cannot be defined in the RibbonDiffXml node for a specific entity.
8787

8888
### Grid ribbons
89-
The entity grid ribbon is a collection of tabs that have an Id attribute value beginning with `Mscrm.HomepageGrid.<entity logical name>`. For example, the tab with the text "Accounts" on an account entity grid is `Mscrm.HomepageGrid.account.MainTab`. All the tabs displayed on the account entity grid will have an Id value that begins with `Mscrm.HomepageGrid.account`.
89+
The entity grid ribbon is a collection of tabs that have an ID attribute value beginning with `Mscrm.HomepageGrid.<entity logical name>`. For example, the tab with the text "Accounts" on an account entity grid is `Mscrm.HomepageGrid.account.MainTab`. All the tabs displayed on the account entity grid will have an ID value that begins with `Mscrm.HomepageGrid.account`.
9090

9191
<a name="BKMK_SubGridRibbons"></a>
9292
### Subgrid ribbons
93-
The entity subgrid ribbon is a contextual group with a collection of tabs that have an Id attribute value beginning with `Mscrm.SubGrid.<entity logical name>`. For example, the tab with the text "Accounts" on account entity sub grid is `Mscrm.SubGrid.account.MainTab`.
93+
The entity subgrid ribbon is a contextual group with a collection of tabs that have an ID attribute value beginning with `Mscrm.SubGrid.<entity logical name>`. For example, the tab with the text "Accounts" on account entity sub grid is `Mscrm.SubGrid.account.MainTab`.
9494

9595
When a list of records for an entity is displayed within a sub grid on the form of another entity or in a chart, there will be only three controls available directly above or within the subgrid. The behaviors for these controls can be modified by changing the commands that they are associated with.
9696

97-
- **Add** The default behavior of the command with the ![Add button](media/customization-subgrid-add.PNG "Add button") icon depends on whether the records in the subgrid are related to the current record.
97+
- **Add**: The default behavior of the command with the ![Add button](media/customization-subgrid-add.PNG "Add button") icon depends on whether the records in the subgrid are related to the current record.
9898

99-
If the records are related to the current record, the default behavior is look for existing records. If an existing record cannot be found, or if the user simply wants to create a new record, they can click **Add New**.
99+
If the records are related to the current record, the default behavior is look for existing records. If an existing record cannot be found, or if the user simply wants to create a new record, they can select **Add New**.
100100

101101
If the records are not related to the current record, the default behavior is to add a new record. If the entity has a Quick Create form this will be displayed, otherwise a new full form will be shown.
102102

@@ -105,13 +105,13 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
105105
> [!NOTE]
106106
> Offline mode in Dynamics 365 does not support many-to-many relationship on custom entities. Due to this, the **Add New** button on a sub grid in Dynamics 365 offline mode will not be displayed.
107107
108-
- **Show List** The command with the ![Open view button](media/customization-open-view.PNG "Open view button") icon will open the full list where all available commands can be used.
108+
- **Show List**: The command with the ![Open view button](media/customization-open-view.PNG "Open view button") icon will open the full list where all available commands can be used.
109109

110110
If the subgrid is associated with the current record, the default behavior of this command is to open the associated view.
111111

112112
If the subgrid is not associated with the current record, the default behavior of this command is to open the view in the main list view.
113113

114-
- **Delete** The ![Sublist delete icon](media/customization-subgrid-delete.PNG "Sublist delete icon") icon is shown on the right side of the row when people hover over the records in the list.
114+
- **Delete**: The ![Sublist delete icon](media/customization-subgrid-delete.PNG "Sublist delete icon") icon is shown on the right side of the row when people hover over the records in the list.
115115

116116
For records with a 1:N relationship or no relationship, the default behavior is to delete the record. The delete may be blocked if it is not allowed due to relationship configurations. Open activities and invoices are common examples of records that may not be deleted due to relationship configurations.
117117

@@ -127,11 +127,11 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
127127

128128
Each entity form can have a specific ribbon definition. In the exported customizations.xml file, you must add your modified `<RibbonDiffXml>` to this ___location:`//ImportExportXml/Entities/Entity/FormXml/forms/systemform/form/RibbonDiffXml`.
129129

130-
The entity form ribbon is a collection of tabs that have an Id attribute value beginning with `Mscrm.Form.<entity logical name>`. For example, the tab with the label **Account** on account entity form is `Mscrm.Form.account.MainTab`. All the tabs displayed on the account entity form will have an Id value that begins with `Mscrm.Form.account`.
130+
The entity form ribbon is a collection of tabs that have an ID attribute value beginning with `Mscrm.Form.<entity logical name>`. For example, the tab with the label **Account** on account entity form is `Mscrm.Form.account.MainTab`. All the tabs displayed on the account entity form will have an ID value that begins with `Mscrm.Form.account`.
131131

132132
<a name="BKMK_BasicHomeTab"></a>
133133
## Basic home tab
134-
The basic home tab is displayed on the main application ribbon whenever an alternative tab is not defined because of entity context or a display rule that suppresses it for specific pages. For example, this tab is displayed when you view the model-driven apps **Help**. The Id of the basic home tab is `Mscrm.BasicHomeTab`.
134+
The basic home tab is displayed on the main application ribbon whenever an alternative tab is not defined because of entity context or a display rule that suppresses it for specific pages. For example, this tab is displayed when you view the model-driven apps **Help**. The ID of the basic home tab is `Mscrm.BasicHomeTab`.
135135

136136
<!-- [!NOTE]-->
137137
<!-- > The Jewel that was shown in [!INCLUDE[pn_crm2011_and_online](../../includes/pn-crm2011-and-online.md)] is no longer displayed. Changes to the Jewel will not appear in [!INCLUDE[pn_dynamics_crm_online](../../includes/pn-dynamics-crm-online.md)] -->
@@ -146,6 +146,15 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
146146
<!--### Microsoft Office Outlook 2010
147147
The [!INCLUDE[pn_crm_for_outlook_full](../../includes/pn-crm-for-outlook-full.md)] controls to support [!INCLUDE[ribbon_enum_Version_2010](../../includes/ribbon-enum-version-2010.md)] toolbars and menus are defined as tabs with the Id values of `Mscrm.Outlook14GlobalToolbar` and `Mscrm.Outlook14GlobalMenubar`, respectively. -->
148148

149+
## Customizing global commandbar
150+
151+
You can customize the global commandbar (`Mscrm.GlobalTab`) by adding the buttons to `Mscrm.GlobalTab`. The out of the box buttons in the global commandbar currently cannot be modified, but new buttons can be added.
152+
153+
When the ___location of the `CustomAction` is set to `Location="Mscrm.GlobalTab.New.Controls._children`, custom button is displayed in the global commandbar at the top of the page.
154+
155+
> [!NOTE]
156+
> This feature is supported only on Unified Interface.
157+
149158
<a name="other_ribbons"></a>
150159
## Other ribbons
151160
Several other special purpose ribbon tabs and a contextual group are defined by model-driven apps.

0 commit comments

Comments
 (0)