Wednesday, May 16, 2012

SharePoint 2010 : Insert custom icon in a custom group on Ribbon of Document Library.


Insert a custom icon(Email icon) on the SharePoint Document Library. The Icon should show in a Custom Group.


I thought getting the Icon on the top was easy(actually it was easy to place an icon on the top). But to place the icon in a Custom Group was a bit tough that it seems.

Follow the steps to achieve

  1. Open Visual Studio 2010, Create an empty SharePoint Application.
  2. Add a Module, Edit the Element.xml
    <?xml version="1.0" encoding="utf-8"?>
    <Elements xmlns="">
            <CommandUIDefinition Location="Ribbon.Documents.Groups._children">
                  Description="E-Mail Controls"
                  Title="E-Mail Controls"
                <Controls Id="EmailDocsCustomGroupControl">
                      Image32by32="/_layouts/1033/images/formatmap32x32.png" Image32by32Left="-448" Image32by32Top="-128"
                      ToolTipTitle="Email Documents"
                      ToolTipDescription="Select the documents which you want to email!"
                      LabelText="Email Selected Documents"
                      TemplateAlias="o1" />
            <CommandUIDefinition Location="Ribbon.Templates._children">
              <GroupTemplate Id="EmailDocsCustomGroupTemplate">
                <Layout Title="LargeLarge">
                  <OverflowSection Type="OneRow" TemplateAlias="o1" DisplayMode="Large"/>
                  <OverflowSection Type="OneRow" TemplateAlias="o2" DisplayMode="Large"/>
            <CommandUIDefinition Location="Ribbon.Documents.Scaling._children">
              <MaxSize Id="Ribbon.Documents.Scaling.Custom.MaxSize" Sequence="15" GroupId="EmailDocsCustomGroup" Size="LargeLarge" />
            <CommandUIHandler Command="SimpleAlert" CommandAction="javascript:OpenEmailPage();" />
       ScriptSrc ="/_layouts/WhatEvePathYouHave/EmailScript.js"/>
  3. Place the EmailScript.js at C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\WhatEvePathYouHave(You can map the folder and do this). With the help of this script you can do manipulations on the click of the icon placed on the top ribbon. Below is the script in EmailScript.js.
    //Get the current user and add the values found in the Email settings list
    function OpenEmailPage() {
        //Gets the current Context
        var _ctx = new SP.ClientContext.get_current();
        //Selected Items Variables
        var _itemIds = "";
        //Get current list id
        var _listId = SP.ListOperation.Selection.getSelectedList();
        var _listUrl = window.location.href;
        //get all selected list items
        var _selectedItems = SP.ListOperation.Selection.getSelectedItems(_ctx);
        //collect selected item ids
        for (var i = 0; i < _selectedItems.length; i++) {
            if (_itemIds == "")
            { _itemIds += _selectedItems[i].id; }
            { _itemIds += "," + _selectedItems[i].id; }
        alert('ListID = ' + _listId + "\nListUrl = " + _listUrl + "\nIDs=" + _itemIds);    
  4. Before deploying the solution, check a document library. The ribbon on the top in the documents should like the below given image.
  5. Deploy the solution. Visit a Document Library, select docs and the new Icon should show up on the top right corner.
I am not very good with Ribbons and spent a lot of time to get just this portion. So thought if this can help many other who dont have time and have to get this quickly.


  1. Thank you Maulik, it is exactly what I need!

  2. i cannot find the icon like you said !!!
    even i dont get how to match or mount the .js file in order that my web site can feel it

  3. i cannot find the icon in the ribbon !!!
    i followed the steps exactly step by step...
    even i can't understand how to mount or match the .js file with my website in order that my website can feel it and add the icon ...

    please help meee.....its urgent !!!

    1. @Anonymous,

      You must be missing something. I have written the blog side by side of my visual studio solution. For the JS you can use a mapped folder and the Element.xml settings will pick that up. Icon doesnot get added due to JS its the element.xml adding the icon. Also you can try clearing the cache.

      Sorry for the late reply. I remainb too busy with work and cannot update my blogs.

      Maulik Dhorajia

    2. Hi Maulik,
      I have a similar question. I need to add custom action button in the list ribbon. When i select some of the list items, the button should be visible. The button should be named as "start owner verification" and should be with an icon. After clicking on the button, the status of all the selected list items should change to "Not Verified" and a nintex site workflow should be triggered on those items
      This is preety urgent. would be relly great if you could help me out. thanks.

    3. @Anonymous - The JavaScript is already returning the ID in the list. Use the list.asmx or something to update the SharePoint list. I am sure that should fire the workflows if they are associated to an item. You should be able to change the title by replacing the "Email Selected Documents".

  4. i want to create a custom group in the list ribbon under "item" tab. how do i do that/ please help me its urgent. Wat should i put in the location property? I have implemented it in the way you have done it above but its not working. tellme where am i going wrong?

  5. Thanks a lot..It saved my time