Skip to main content

Load dynamically JavaScript file inside Custom Action

This starts to be very common scenario in the SharePoint online projects:


You want to have custom actions (“My Action”) that execute custom logic.
The main challenge is how to load the JavaScript file with this custom logic (/sites/demo/SiteAssets/Actions/dts.demo.script.js) only when the custom action needs it.

One approach described in many posts is to use a Script link. 
Here is a working example:

    function RegisterScriptLink() {

        var scriptBlock = 'var headID = document.getElementsByTagName("head")[0];var newScript = document.createElement("script");newScript.type = "text/javascript";newScript.src = "'
        scriptBlock += '/sites/demos/SiteAssets/Actions/dts.demo.script.js' + '?ver=' + ((new Date()) * 1);
        scriptBlock += '";headID.appendChild(newScript);';

        var context = new SP.ClientContext.get_current;
        this.site = context.get_web();
        var collUserCustomAction = this.site.get_userCustomActions();
        var scriptLink = collUserCustomAction.add();
        scriptLink.set_name('DTSDemo Script');
        scriptLink.set_title('DTSDemo Script');
        scriptLink.set_scriptBlock(scriptBlock);
        scriptLink.set_location('ScriptLink');
        scriptLink.set_group('');
        scriptLink.update();
        context.executeQueryAsync(
            function (a, b) {
                console.log('success');
            },
                function (a, b) {
                    console.log('error');
                    console.log(a);console.log(b);
                });
    }
    
The problem here is that you will load the script to all pages inside the web (!), which is not the best architecture.

The solution I find better is to load the file inside the custom Action.
Note that I create the custom actions with JavaScript instead of SharePoint designer! This one way to automate and simplify the deployment of your project. Also this provides you more options to configure the action.

Ribbon Action
Use the EnabledScript methold to load you script. Here is an example:



ECB Action




Here is the link to the code from this post.



PS: Your feedback is highly appreciated. 


Comments

Popular posts from this blog

ClientPeoplePicker in SharePoint 2013

Start using SharePoint 2013 I noticed that the way for selecting people or groups is changed.
The new way is simple – just ‘Enter name or email address’ without any icons for ‘Check Names’ or ‘Browse’. I guess that the PeoplePicker is changed but NO. PeoplePicker sitll has the same functionality as before.
There is a new control called ClientPeoplePicker.

How to use it:
1.Add this references

<%@RegisterTagPrefix="wssawc"Namespace="Microsoft.SharePoint.WebControls"Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>
2.Add the following control declaration


      <wssawc:ClientPeoplePicker Required="true" ValidationEnabled="true" ID="peoplePicker" runat="server" InitialHelpText="<%$Resources:wss,aclinv_PickerIntialHelperText%>" VisibleSuggestions="3" Rows="1" AllowMultipleEntities="false" CssClass

The column name that you entered is already in use or reserved. Choose another name.

The problem: 
You want to create column with a specific name in SharePoint but SharePoint gives you the message "The column name that you entered is already in use or reserved. Choose another name."



Why this is a problem?
Because you need to create custom columns and content types using the default SharePoint interface.
And the business users have to see properly named columns - for example "Description", not "My Description".

Solution:
It is important to know something technical about SharePoint (versions Office 365, 2013, 2010):
 - it supports columns with same Display Names.
 - you can’t have columns with same Internal names

Let’s implement the following common scenario:
You are creating a SharePoint customization and you need the following column:
   Type: Multiple lines of text
   Internal Name: MyProjectDescription
   Display Name: Description

 Here is the correct way to achieve it:
1. Create the column MyProjectDescription.
This will create column with I…

Office 365 Migration API: how to migrate the taxonomy metadata

If you wander whether the Office 365 Migration API supports migration of taxonomy metadata, the answer is YES. The API supports it but there isn't good documentation about how to modify your xml files after the command ConvertTo-SPOMigrationTargetedPackage.

In this post, I'm going to show you the approach. I assume that you have base knowledge of how to use the Migration API.

The scenario I'm going to use is simple - migrate single Document library with single document.
The document has one taxonomy column (MyTaxonomy) and three versions:

Here are the steps:

Step 1: Export the document library

Export-SPWeb "https://portal.cosingens.com/" ` -ItemUrl "/Shared Documents" ` -Path "\\cos-dev-03\export1\Export" ` -NoFileCompr -IncludeVersions 4
This command will export the document library and will create the initial package.
The command is not part of the Migration API. It is well know since SharePoint 2010 and is part of the server side obje…