Add Custom Ribbon Items To List Forms On SharePoint Using CSOM PowerShell

Steps Involved

The following prerequisites are required to be executed, before going for any operations, using CSOM PowerShell on SharePoint sites.

We will see how we can add the custom ribbon items (actions) to the SharePoint list forms. The following are the steps, common to any list form. The code snippets, for adding ribbon items to various forms are shown in the sections, below:

• Get the existing user action collection. Access the Web and get the existing user actions, using UserCustomActions property. Load and execute the property.
  
  
• Add new custom action to the user actions collection. The necessary parameters for new action are registration ID, title, registration type and location.
  
  
• Registration ID - Corresponding List template ID to add the user action. For example, here 100 denotes the custom list templates.
• Registration Type - Denotes association type.
• Location - Custom action location.
  
  
• Build the XML for the new definition with corresponding handler. In this case, I have considered button as a custom action and associated alert box to the action. You can build your own logic on the command action parameter. Location in the XML denotes the place, where item will be placed in the ribbon.
  
  
• Update and execute to see the changes.

• The ribbon custom action location should be CommandUI.Ribbon.DisplayForm.
  
  
• The command definition location should look like Ribbon.ListForm.Display.Actions.Controls._children. Here, the location denotes the command will be added in actions group under ribbon. You can specify other group names as well.
  
  
• The command action shows the custom function, to be defined. Here, you will get an alert box with the corresponding item ID on click of a button.