Set a ribbon user custom action using PowerShell

Question

How to fully defined and add a user custom action using PowerShell. I was able to define and add a custom action but I don't know how to point to a JS file that contains the JavaScript I would like to execute.

So far, I am there:

$web = Get-SPWeb $web;
$list = $web.lists[$listTitle];
$UCACollection = $list.userCustomActions;
$newUCA = $UCACollection.add();
$newUCA.CommandUIExtension = '<CommandUIExtension xmlns="http://schemas.microsoft.com/sharepoint/">' +
                    '<CommandUIDefinitions>' +
                        '<CommandUIDefinition Location="Ribbon.List.Actions.Controls._children">'+
                            '<Button Id="Ribbon.Documents.UCAID" '+
                                    'Command="Notify" '+
                                    'Sequence="0" '+
                                    'Image16by16="/mysite/siteAssets/my-icon-16x16.png" '+
                                    'Image32by32="/mysite/siteAssets/my-icon-32x32.png" '+
                                    'Description="My description." '+
                                    'LabelText="TitleofcustomAction" '+
                                    'TemplateAlias="o1"/>' +
                        '</CommandUIDefinition>'+
                    '</CommandUIDefinitions>'+
                    '<CommandUIHandlers>'+
                        '<CommandUIHandler Command="Notify" '+
                            'CommandAction="javascript:JsFunctionInJsFileInSiteAssets();" />'+
                    '</CommandUIHandlers>'+
                  '</CommandUIExtension>';
$newUCA.Location = 'CommandUI.Ribbon.ListView';
$newUCA.Title = "MyTitle";
$newUCA.ScriptSrc = "/mysite/siteAssets/function.js";
$newUCA.update();

When using this script I receive :

Validation error has occurred. The property ScriptSrc can be used only if the property Location is set to "ScriptLink".

So, I do put ScriptLink inside, and then I receive :

Validation error has occurred. The property ScriptSrc can be used only if the property Location is set to "!ScriptLink".

What do I have to do to defined a complete and working list ribbon user custom action using PowerShell? When googling, I didn't find even a single example.

Answer 1

I have my custom action written JavaScript as follows.

var action = userCustomActions.add();
action.set_location("ScriptLink");
action.set_title(srcurl);
action.set_scriptSrc("~sitecollection/SiteAssets/" + srcurl);
action.set_sequence(srcsequence);
action.update();

According to this I am thinking in your case the following statement can be updated as follows

$newUCA.Location = "ScriptLink"

Answer 2

The ScriptSrc attribute is only applicable when the Location attribute is set to ScriptLink.

What you need to do is to remove the ScriptSrc attribute from your custom action, and then create an additional custom action that serves the script. See below:

<CustomAction Id="ScriptSource1"
              ScriptSrc="/mysite/siteAssets/function.js"
              Location="ScriptLink"
              Sequence="100">
</CustomAction>

If you do not want to have 2 custom actions due to performance concerns, then you need to write JS code that loads the JS file and then executes your function. That JS code would have to be placed inside CommandAction attribute like this:

CommandAction="javascript: <JS code that loads JS file from Site Assets>;
                           JsFunctionInJsFileInSiteAssets();"

You may want to use dynamic loading, namely the SP.SOD.registerSod and SP.SOD.executeFunc functions. See third link in the references below.

Or if the code in the JS file is not too large, you could get rid of the JS file and place your entire code inside the CommandAction attribute.

---

References:

• https://msdn.microsoft.com/en-us/library/office/ms460194.aspx
• https://nauzadk.wordpress.com/2012/10/02/working-with-commandaction-and-urlaction/
• http://www.kalmstrom.com/Tips/SPDevDynamicLoading.htm