Pass data from a page as a parameter to ribbon actions

Note

This topic is about classic commands.

There is a new way to define commands. See Modern commanding overview (preview).

When you define an action in a ribbon, you frequently have to pass data from the page to either a JavaScript function or a URL. This article describes options for using the <CrmParameter> element to retrieve these values.

Form and grid context in ribbon actions

To pass in the execution context (form context or grid context) information to JavaScript function for your ribbon actions, specify PrimaryControl for the form context, or SelectedControl for the grid context as the <CrmParameter> value in your ribbon definition. SelectedControl will pass in the grid context, for both subgrids and homepage grids. The passed in PrimaryControl or the SelectedControl value is used as an argument in your JavaScript function for form context or grid context respectively.

For example, here is a sample ribbon definition where we pass in the PrimaryControl parameter to the JavaScript function:

<CommandDefinition Id="SampleCommand">
  <EnableRules/>
  <DisplayRules/>
  <Actions>
    <JavaScriptFunction Library="$webresource:new_mySampleScript.js" FunctionName="mySampleFunction">
      <CrmParameter Value="PrimaryControl" />
    </JavaScriptFunction>
  </Actions>
</CommandDefinition>

Next, in the new_mySampleScript.js web resource file referenced in the example above, define your JavaScript function with the primaryControl variable as an argument. This argument provides the form context where the ribbon command is executed:

function mySampleFunction(primaryControl) {
    var formContext = primaryControl;
    // Perform operations using the formContext object
}

You can also specify CommandProperties as <CrmParameter> value in your ribbon definition to pass details about the event from the ribbon control. You can use this to send contextual information to your JavaScript function where specific actions can be determined based on the context of the event.

Note

Getting form context and grid context for JavaScript functions for ribbon actions is different from how you get these values in form scripting. For information about form scripting and how to get these contexts, see Client API form context and Client API grid context.

Form values

With a form ribbon, you can use the data.entity.attributes collection and the ui.controls collection to retrieve and set values for known columns.

For example, the following sample code shows how to retrieve the account name column on the account form, and then set a value in the websiteurl column based on the account name value:

function mySampleFunction(primaryControl) {
    var formContext = primaryControl;    
    var accountName = formContext.getControl("name").getAttribute().getValue();    

    // Set the WebSiteURL column if account name contains "Contoso"
    if (accountName.toLowerCase().search("contoso") != -1) {
        formContext.getAttribute("websiteurl").setValue("https://www.contoso.com");
    }
    else {
        Xrm.Navigation.openAlertDialog({ text: "Account name does not contain 'Contoso'." });
    }
}

Grid values

The majority of the values available for the <CrmParameter> element are related to working with data displayed in a grid or hierarchy chart. By using the Value parameter enumeration options, you can easily isolate items by:

• Selected items

  • SelectedControlSelectedItemCount

  • SelectedControlSelectedItemIds

  • SelectedControlSelectedItemReferences

• All items

  • SelectedControlAllItemCount

  • SelectedControlAllItemIds

  • SelectedControlAllItemReferences

• Unselected items

  • SelectedControlUnselectedItemCount

  • SelectedControlUnselectedItemIds

  • SelectedControlUnselectedItemReferences

  For each of these groupings, you can gather the number of items and the GUID identifier. If you are passing the values to a URL, you can also retrieve EntityReference objects that contain all the information that you need to uniquely identify the objects in the grid. These parameters apply whether the page viewed is the main grid (HomepageGrid) or a sub grid located in a form. When used together with the SelectedEntityTypeName parameter, you have all the information that you must have to pass to another application.

Other context information

In addition to data values, you can retrieve client context information by using <CrmParameter>. You can use the following options as the value for the CrmParameter element: OrgName, OrgLcid, and UserLcid.

For a <Url> action, you can also use the PassParams to include contextual information.

The Value options PrimaryEntityTypeName and FirstPrimaryItemId provide information for a table record. You can use PrimaryItemIds for a HomepageGrid ribbon to get a list of all the displayed items.

See also

Customize the ribbon
Passing parameters to a URL using the ribbon
Define ribbon actions
Define custom actions to modify the ribbon
Client API form context
Client API grid context