SharePoint Pals
 | Sign In
How to Add/Remove User Custom Actions (in Site Actions Menu) Programmatically using CSOM PNP in SharePoint Office 365
by Sathish Nadarajan 23 Oct 2016
Author
SharePoint MVP
Visits   
Today  :   15     Total  :    2043

In some of the requirements, we might be creating the custom components, pages, links to external applications, APPs (Add-in), which require some link from the home page. Either we can provide a hyperlinks on the Screens or we can attach those links on the Site Actions Menu. Obviously, adding to the Site Actions menu, is purely discrete to the customer’s wish. But, even then, let us see how to Create the Menu Items, programmatically. This will be useful, during the time of deployment.

In the Site Actions Menu, the default items will be listed as below.

clip_image002

Now, we are going to add a link at the bottom as below.

clip_image004

The piece of code to Add and Remove is as follows.

 namespace Console.Office365
 {
     using Microsoft.SharePoint.Client;
     using Newtonsoft.Json.Linq;
     using System;
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
 
     class Program
     {
         static void Main(string[] args)
         {
 		RemoveLinkOnCustomAction();
             AddLinkOnCustomAction();
         }
 
         
 
         
 
         public static void RemoveLinkOnCustomAction()
         {
             OfficeDevPnP.Core.AuthenticationManager authMgr = new OfficeDevPnP.Core.AuthenticationManager();
 
             string siteUrl = "http:// **********.sharepoint.com/sites/communitysite";
             string userName = "Sathish@**********.onmicrosoft.com";
             string password = "**********";
 
             using (var ctx = authMgr.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userName, password))
             {
                 Web web = ctx.Web;
                 ctx.Load(web);
                 ctx.Load(web.UserCustomActions);
                 ctx.ExecuteQueryRetry();
                 foreach (var customAction in web.UserCustomActions)
                 {
                     if (customAction.Name == "Test Action")
                     {
                         customAction.DeleteObject();
                         break;
                     }
                 }
                 ctx.Web.Update();
                 ctx.Web.UserCustomActions.RefreshLoad();
                 ctx.ExecuteQueryRetry();
             }
         }
 
         public static void AddLinkOnCustomAction()
         {
             OfficeDevPnP.Core.AuthenticationManager authMgr = new OfficeDevPnP.Core.AuthenticationManager();
 
             string siteUrl = "https:// **********.sharepoint.com/sites/communitysite";
             string userName = "Sathish@**********.onmicrosoft.com";
             string password = "******";
 
             using (var ctx = authMgr.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userName, password))
             {
                 Web web = ctx.Web;
                 ctx.Load(web);
                 ctx.Load(web.UserCustomActions);
                 ctx.ExecuteQueryRetry();
 
                 BasePermissions permission = new BasePermissions();
                 permission.Set(PermissionKind.ManageWeb);
 
                 UserCustomAction siteAction = ctx.Web.UserCustomActions.Add();
 
                 siteAction.Group = "SiteActions";
                 siteAction.Location = "Microsoft.SharePoint.StandardMenu";
                 siteAction.Name = "Test Action";
                 siteAction.Sequence = 1000;
                 siteAction.Rights = permission;
 
                 siteAction.Url = "www.google.com";
                 siteAction.Title = "Link to Google";
                 siteAction.Update();
 
                 ctx.ExecuteQueryRetry();
             }
         }
 
 
     }
 
 }
 

Happy Coding,

Sathish Nadarajan.

blog comments powered by Disqus

SharePoint Pals

Pals
SharePoint Pals, a community portal for SharePoint developers, Administrators and End Users. Let's join hands and share the point together.
Read this on mobile

Training

Angular Js Training In Chennai
Advanced Angular Js training with real world developer scenarios
Angular Js, Web Api and Ionic for .Net Developers
All in one client side application development for .Net developers
Angular Js For SharePoint Developers
Get ready for the future. Its no more just C#

Get Connected

SharePoint Resources

SharePoint 2013 and 2010 Web Parts
Free Web Parts with Source Code for SharePoint Community




SharePoint 2013 Books and Tutorials
Collection of free SharePoint 2013 books and tutorials (eBooks, pdfs)

Supported By

Contribute your article and be eligible for a one month Free Subscription for Plural Sight. The Author of the most popular New Article (published in the previous month) will be awarded with a Free One month Plural Sight Subscription. Article can be sent to articles@sharepointpals.com in a word document.

Related Resources

Recent Tweets

Twitter November 21, 21:08
Implementing Multi-Threading with MaxDegreeOfParallelism in SharePoint using CSOM – An Insight - https://t.co/RNM7eVuyaa

Twitter November 21, 12:48
Configure Windows Firewall for SQL Server Analysis Service (SSAS) - https://t.co/re2H0cnGwn

Twitter November 21, 12:46
Implementing Multi-Threading in SharePoint To Upload Files using CSOM C# – An Insight - https://t.co/18QwUQG2eR

Twitter November 20, 21:48
How to Get the Client Context Using App Access token, by passing Client ID using CSOM in SharePoint Office 365 - https://t.co/wpmlJfTeWx

Twitter November 18, 21:30
How to Enable Auto Approval For Permission Requests in Community Site Template – Office 2013 using Client Side Object Model (CSOM) C#

Follow us @SharePointPals
Note: For Customization and Configuration, CheckOutRecent Tweets Documentation