Expand Minimize

Deploy missing file in CommandUIHandler for CustomAction

If a CustomAction references a file in ribbon CommandUIHandler (e.g. a page) the file must be deployed.

CheckId SPC015706
TypeName DeployMissingRibbonCommandUIHandlerOfCustomAction
Severity Error
Type CustomAction

Add the necessary file to the solution as TemplateFile. See sample below:

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
   <CustomAction Id="Ribbon.Library.Actions.ReplacementButton"
      Location="CommandUI.Ribbon"
      RegistrationId="101"
      RegistrationType="List"
      Title="Replace a Ribbon Button">
      <CommandUIExtension>
         <CommandUIDefinitions>
            <CommandUIDefinition Location="Ribbon.Library.Actions.ConnectToClient">
            ...
            </CommandUIDefinition>
         </CommandUIDefinitions>
         <CommandUIHandlers>
            <CommandUIHandler Command="CommandSettings" CommandAction="~site/_layouts/Action.aspx?List={ListId}" />
         </CommandUIHandlers>
         ...
      </CommandUIExtension>
   </CustomAction>
</Elements>

To suppress this violation in XML SharePoint code add the following comment right before the XML tag which causes the rule violation. Learn more about SuppressMessage here.

<!-- "SuppressMessage":{"rule":"SPC015706:DeployMissingRibbonCommandUIHandlerOfCustomAction","justification":"Provide reason for suppression here"} -->
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.