Ribbon Walkthroughs

Article
10/04/2013

[Applies to: Microsoft Dynamics CRM 2011]

Customizing the ribbon requires that you successfully apply several concepts to achieve expected results. The walkthroughs in this section begin with a specific goal and explain how that goal can be achieved.

To successfully complete these walkthroughs you should have a basic understanding of the concepts introduced in this area of the SDK. Each walkthrough contain the following high level steps:

Prerequisites: This section describes the specific requirements and resources you need.
Export: Create and export a solution containing just the solution components you need. For more information about creating and exporting a solution see the application Help and Export the Ribbon.
Identify the IDs for existing items: Examine default ribbon definitions. The walkthrough provides the XML you need, but it is important that you understand the relationships to existing data in the default ribbon definitions.
Create the script Web resource: Walkthroughs that add controls to the ribbon require a JScript Web resource to perform an action. For more information about creating JScript Web resources, see the application Help and JScript Libraries for Microsoft Dynamics CRM.
Edit the customizations.xml file: This section leads you through a series of cumulative steps editing nodes within the <RibbonDiffXml> (RibbonDiffXml) element. The final step shows you the entire modified RibbonDiffXml element in the customizations.xml file.
Import and publish the solution: Compress the modified solution files and import those files to update your solution. For more information about compressing and importing a solution, see the application Help and Import the Ribbon.
Test and verify that the requirements are met: In this step you confirm that the requirements specified in the prerequisites section are met.