Armanino Blog
Article

Writing JavaScript Ribbon Button Functions against Grids in Microsoft CRM 2011

August 30, 2013

Executing actions against multiple items in a CRM grid using JavaScript can really help a user's productivity. For that reason, we'd like to provide a few pointers on how to develop scripts that can run against grid items in Microsoft Dynamics CRM. Please note that this overview is intended for seasoned developers, and leaves out some basic details.

The JavaScript function action for ribbon buttons in Microsoft Dynamics CRM supports a number of parameters to be passed to your script. For a full list of available parameters, please refer to the Microsoft SDK.

When writing your JavaScript function, keep in mind that the ribbon button JavaScript function executed from a HomeGrid or SubGrid cannot access the Xrm.Page object model. To do this you will need to utilize getGlobalContext (http://msdn.microsoft.com/en-us/library/gg328541.aspx) and SOAP or OData/REST (http://msdn.microsoft.com/en-us/library/gg490659 ) for data access and manipulation. Actions that are executed from a form ribbon button do have full access to the Xrm.Page object and execute just like any standard form JavaScript.

JavaScript Example:

If you have a function that you want available from both a form and grid, we would suggest writing one master function that takes in the ID of a single object and does the manipulation as well as entry function for the form and the grid. See the example below (click to enlarge image):

Ribbon 1

Ribbon Button Action Examples:

This guide will focus on Actions for your button and assumes you know the basics of creating a ribbon button in CRM. Using the code example above, your action on the form would simple be (click to enlarge image):

Ribbon 2

To run against selected items in a grid you can utilize the following action:

Ribbon 3

And finally, to run against all items on the current grid (this only runs against the items on the current page):

Ribbon 4

One last tip, when running a function against a large number of items in a grid it is a good idea to implement some sort of a dialog to let the user know that the function is still running. This should cut down on users leaving the page and causing the script to fall out of scope then throw an exception.

Stay In Touch

Sign up to stay up-to-date with the latest accounting regulations, best practices, industry news and technology insights to run your business.

Resources
Related News & Insights
Want to Thrive in the AI Era? Unify Your ERP and HR Systems
Article
The question: do you stay with a best-of-breed approach or move to an all-in-one system?

December 10, 2024
Year-End Tax Planning for Individuals
White Paper
2024 is a pivotal year for tax planning and legacy giving. Learn how you can take advantage of expiring tax savings.

December 06, 2024
A Deep Dive of Business Valuation Discounts
Webinar
Get expert tips to better estate plans for your clients.

December 5, 2024 | 10:00 AM - 11:00 AM PT