Add Ribbon Button via JavaScript

Question

I have specific requirements from my client that he wants to add some additional Ribbon Button "but only" via JavaScript (including EnableScript reading value from some other list). They don't want to deploy anything to SharePoint server.

So I know how to that via recommended way

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction Id="HelloWorldExample"
                Title="Hello WorldExample"
                Location="CommandUI.Ribbon"
                RegistrationType="List"
                RegistrationId="101">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition Location="Ribbon.Documents.Manage.Controls._children">
          <Button Id="Ribbon.HelloWorldExample"
                  TemplateAlias="o1"
                  Command="HelloWorldExample"
                  LabelText="Hello world Example"/>
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler Command="HelloWorldExample"
                          CommandAction="javascript:alert('Hello world Example from ribbon !');"
EnabledScript="javascript:
           function getStatus()
           {
             //check  something
           }
           return false;" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

But how to accomplish this just via JavaScript/jQuery?

Answer 1

They have a JavaScript API for this: http://msdn.microsoft.com/en-us/library/office/ff408647(v=office.14).aspx

You can even add command ui extension like you have them.

var context = new SP.ClientContext.get_current();
this.site = context.get_web();
var customAction = this.site.get_userCustomActions().add();
customAction.set_location('CommandUI.Ribbon.NewForm');

var uiExtension = '<CommandUIExtension xmlns="http://schemas.microsoft.com/sharepoint/">' +
                        '<CommandUIDefinitions>' +
                            '<CommandUIDefinition Location="Ribbon.ListForm.Edit.Commit.Controls._children">'+
                                '<Button Id="Ribbon.Documents.New.RibbonTest" '+
                                        'Command="PrintPage" '+
                                        'Sequence="0" '+
                                        'Image16by16="/_layouts/images/NoteBoard_16x16.png" '+
                                        'Image32by32="/_layouts/images/NoteBoard_32x32.png" '+
                                        'Description="Uses the notification area to display a message." '+
                                        'LabelText="Notify hello" '+
                                        'TemplateAlias="o1"/>' +
                            '</CommandUIDefinition>'+
                        '</CommandUIDefinitions>'+
                        '<CommandUIHandlers>'+
                            '<CommandUIHandler Command="PrintPage" '+
                                'CommandAction="javascript:SP.UI.Notify.addNotification(\'Hello from the notification area\');" />'+
                        '</CommandUIHandlers>'+
                       '</CommandUIExtension>';

customAction.set_commandUIExtension(uiExtension);

customAction.set_registrationId("0x0108");
customAction.set_registrationType(SP.UserCustomActionRegistrationType.contentType);

customAction.update();

context.load(this.site,'UserCustomActions');

context.executeQueryAsync(Function.createDelegate(this, this.onSuccess),
        Function.createDelegate(this, this.onFailure));

Answer 2

Nevermind my previous answer, forget I said anything. In javascript, you can create a set elements without having to write anything in the original html document. functions like *.createElement(), *.class(), and *.id() can let you create and configure your html element.

Here is the link to all the Javascript functions for this.

And here is a link to add attributes to an element.

So your javascript will be something like:

function myRibbonButton() {
var btn=document.createElement("myButton");
btn.id = "myID";
btn.class = ...
//and so on
}

So you can create elements in javascript, just tailor it to what you need.

Answer 3

This would help.

• There’s a JavaScript API for Creating Ribbons! http://dbremes.wordpress.com/2011/01/16/theres-a-javascript-api-for-creating-ribbons/

• Intro to Manipulating the SharePoint 2010 Ribbon with JavaScript http://sharepointtaproom.com/2011/09/09/intro-to-manipulating-the-sharepoint-2010-ribbon-with-javascript/

Plus, surely, the same stuff can be deployed via CSOM and UserCustomActions.