Define ribbon actions
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Define the actions to be performed by a command bar or ribbon control in a <CommandDefinition> (RibbonDiffXml) element together with rules that control whether the control is enabled or visible in the ribbon.
A Ribbon control can perform two types actions and may include multiple actions:
Open a URL: The ribbon opens a URL using the value from an Address attribute in the <Url> (RibbonDiffXml) element. Additional parameters can pass information about how what querystring parameters are passed and the mode in which the window opens.
You have several options to pass parameters to a URL using the ribbon. More information: Pass parameters to a URL by using the ribbon
Use the following elements to define data to pass to your custom action:
- <BoolParameter> (RibbonDiffXml)
Specifies a value with a Boolean data type that may be passed as a parameter.
- <CrmParameter> (RibbonDiffXml)
Represents data retrieved from the Microsoft Dynamics 365 application that may be passed as a parameter.More information: Pass Microsoft Dynamics 365 data from a page as a parameter to Ribbon Actions
- <DecimalParameter> (RibbonDiffXml)
Specifies a value with a decimal data type that may be passed as a parameter.
- <IntParameter> (RibbonDiffXml)
Specifies a value with an integer data type that may be passed as a parameter.
- <StringParameter> (RibbonDiffXml)
Specifies a value with a string data type that may be passed as a parameter.
When parameters are passed to a <Url> (RibbonDiffXml) element they are passed as a query string. Therefore, they must include a name value to represent the ”key” in the query string key/value pair.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright