Ribbons Available in Microsoft Dynamics CRM

[Applies to: Microsoft Dynamics CRM 2011]

This topic describes where ribbons are defined and modified in Microsoft Dynamics CRM 2011.

In This Topic

Ribbon Definitions

Microsoft Dynamics CRM contains default <RibbonDiffXml> (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. All of your changes will be in the <CustomAction> (RibbonDiffXml) or <HideCustomAction> (RibbonDiffXml) elements. These elements are applied over the default ribbon definitions provided by Microsoft Dynamics CRM 2011.

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.

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.

To help you get started, the definitions of the default ribbon definitions are included in the downloadable files in the Microsoft Dynamics CRM SDK. The SDK\Resources\ExportedRibbonXml folder includes the output files you would have for an organization with a ribbon that has not been customized. You don’t need to run the sample application to export this data. If you have a customized ribbon, you should run the sample application to refresh the files in this folder with any customizations previously applied for your organization.

Within the exported ribbon XML files, the applicationRibbon.xml file includes all the ribbons that are not defined for a specific entity. These correspond to the Application Ribbons solution component. For each entity, you will find an entity nameribbon.xml file. This corresponds to the RibbonDiffXml that is included in each entity. If you want to edit the ribbon for a specific entity, you should locate the ribbon XML file for that entity.

Entity Ribbons

All entities use a common ribbon definition called the Entity Ribbon Template. The entity ribbon template definition is located in the applicationribbon.xml file. When you create a custom entity, the ribbon you see is the default ribbon defined by the entity ribbon template. Each system entity has a separate <RibbonDiffXml> (RibbonDiffXml) definition that builds upon the entity ribbon template definition.

Within the applicationribbon.xml file, you can see the following tabs that apply to all entities:

  • Mscrm.Form.{!EntityLogicalName}.MainTab

    Tab displays the entity display name in the label.

  • Mscrm.Form.{!EntityLogicalName}.Related

    Tab has the label Add.

  • Mscrm.Form.{!EntityLogicalName}.Developer

    Tab has the label Customize.

  • Mscrm.HomepageGrid.{!EntityLogicalName}.MainTab

    Tab displays the plural entity display name in the label.

  • Mscrm.HomepageGrid.{!EntityLogicalName}.View

    Tab has the label View.

  • Mscrm.HomepageGrid.{!EntityLogicalName}.Related

    Tab has the label Add.

  • Mscrm.HomepageGrid.{!EntityLogicalName}.Developer

    Tab has the label Customize.

  • Mscrm.SubGrid.{!EntityLogicalName}.ContextualTabs

    When a sub grid in a form or chart has focus, the contextual tab appears with the label List Tools.

    • Mscrm.SubGrid.{!EntityLogicalName}.MainTab

      Tab displays the plural entity display name.

When you view the ribbon definitions for a specific entity, you will see that the name of the entity usually replaces the {!EntityLogicalName} token. When you see the {!EntityLogicalName} token in the ribbon definition for a specific entity, that means there is no specific definition for that entity and it simply uses the definition from the entity ribbon template. When you define ribbons for a specific entity, always use the actual entity name. Ribbon modifications for a specific entity must be defined in the //ImportExportXml/Entities/Entity/RibbonDiffXml node.

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. For more information, see Walkthrough: Add a Custom Button to an Existing Group for all Entities.

Grid Ribbons

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.

Sub Grid Ribbons

When a list of records for a different entity is displayed within a sub grid on the form of another entity or in a chart, the ribbon will change when the user places the cursor in the grid. A contextual group with the label List Tools is displayed. The single tab included in that contextual group will have the plural display name of the entity.

The entity sub grid 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.

Form Ribbons

Each entity can have multiple forms. You can define changes to the form ribbon for all forms for that entity by adding your definition at the entity level (//ImportExportXml/Entities/Entity/RibbonDiffXml).

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

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.

Web Application Ribbons

Certain ribbon components display in the Web application outside of a specific entity context:

Jewel

The jewel is the blue tab with the label File that appears on the far left of the ribbon. The jewel is also displayed on the entity form. The jewel provides a <Menu> (RibbonDiffXml) element with the Id Mscrm.Jewel.Menu.

Basic Home Tab

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 Microsoft Dynamics CRM Resource Center. The Id of the basic home tab is Mscrm.BasicHomeTab.

Microsoft Dynamics CRM for Microsoft Office Outlook Ribbons

Microsoft Office Outlook 2003 and 2007 do not display a ribbon. Microsoft Office Outlook 2010 uses the ribbon. You can use Microsoft Dynamics CRM ribbon definitions to add controls to all of them.

Microsoft Office Outlook 2003 and 2007

The Microsoft Dynamics CRM for Microsoft Office Outlook controls to support older versions of Microsoft Office Outlook toolbars and menus are defined as tabs with the Id values of Mscrm.LegacyOfficeToolbar and Mscrm.LegacyOfficeMenubar, respectively.

Microsoft Office Outlook 2010

The Microsoft Dynamics CRM for Microsoft Office Outlook controls to support Microsoft Office Outlook 2010 toolbars and menus are defined as tabs with the Id values of Mscrm.Outlook14GlobalToolbar and Mscrm.Outlook14GlobalMenubar, respectively.

Other Ribbons

Several other special purpose ribbon tabs and a contextual group are defined byMicrosoft Dynamics CRM. Each tab is associated with a specific <TabDisplayRule> (RibbonDiffXml) that controls when they will display. The following table lists these tabs.

 

Tab Root Id Description

Web Resource Edit page tab.

Mscrm.WebResourceEditTab

Displays when editing Web resources within a solution.

Form Editor tab

Mscrm.FormEditorTab

Provides Save, Edit, Select, and View groups of actions for entity forms.

Form Editor Insert tab

Mscrm.FormEditorInsertTab

Provides buttons to insert Sections, Tabs, and Controls in entity forms.

Dashboard Homepage tab

Mscrm.DashboardTab

Displays in the Workplace area.

Visualization Tools Contextual Group

Mscrm.VisualizationTools

Displays when the New Chart button is clicked on the Charts tab displayed in the entity grid ribbon.

AptbookTab Homepage tab

Mscrm.AptbookTab

Displays when viewing the Service Calendar in the Service area.

Advanced Find tab

Mscrm.AdvancedFind

Displays in the Advanced Find window.

Dashboard Editor tab

Mscrm.DashboardEditorTab

Displays when editing a dashboard.

Documents tab

Mscrm.DocumentsTab

Displays if SharePoint integration has been enabled for the organization.

Chart Editor tab

Mscrm.VisualizationDesignerTab

Displays when editing a chart from the solutions window.

Search Tools Contextual Group

Mscrm.ArticleSearch

Displays when viewing the KBarticle entity.

Ribbons for Custom Pages

You can display custom pages in the application navigation using the SiteMap. These pages will always display the Basic Home Tab (Mscrm.BasicHomeTab). It is not possible to use a <PageRule> (RibbonDiffXml) to enable or display custom ribbon components on custom pages.

See Also

Other Resources

Customize the Ribbon

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.

Community Additions

ADD
Show: