SharePoint 2013 Hosting – HostForLIFE :: Add, Update And Remove Web Part Using CSOM

Introduction

Web parts are the building blocks of the pages by which you can modify the content, appearance and behavior of pages of a SharePoint site.

In this blog we are going to discuss how to Add, Update and Remove the web part using csom. Here I have used Content Editor Web Part in Wiki page.

Adding the web part in a wikipage

Step 1

First set the credentials by providing the user credentials.

Step 2

Using the client context, load the web.

Step 3

Get the object of the file using server relative url of the wiki page in which you want to add the web part. Example (/sites/Team Site/Site Pages/wikiPage.aspx).

Step 4

Get the ‘limitedWebPartManager‘ by using object file.

Step 5

Design the Xml string for importing the web part as definition of web part in ‘limitedWebPartManager’. In xml I have added the Title of web part as ‘My Web Part’.

Step 6

Then add the web part order and left zone of the page.

Follow the below code snippet,

<span class="keyword">using</span> System;  

<span class="keyword">using</span> Microsoft.SharePoint.Client;  

<span class="keyword">using</span> Microsoft.SharePoint.Client.WebParts;  

<span class="keyword">using</span> System.Security;  

<span class="keyword">namespace</span> webpartadd {  

    <span class="keyword">class</span> Program {  

        <span class="keyword">static</span> <span class="keyword">void</span> Main(<span class="keyword">string</span>[] args) {  

            <span class="keyword">string</span> userName = <span class="string">"userName@tenantName.onmicrosoft.com"</span>;  

            <span class="keyword">string</span> password = <span class="string">"PassWord"</span>;  

            <span class="keyword">string</span> siteUrl = <span class="string">"https://tenantName.sharepoint.com/sites/TeamSite"</span>;  

            SecureString securePassword = <span class="keyword">new</span> SecureString();  

            <span class="keyword">foreach</span>(<span class="keyword">char</span> c <span class="keyword">in</span> password) {  

                securePassword.AppendChar(c);  

            }  

            var credentials = <span class="keyword">new</span> SharePointOnlineCredentials(userName, securePassword);  

            <span class="keyword">using</span>(ClientContext clientContext = <span class="keyword">new</span> ClientContext(siteUrl)) {  

                <span class="keyword">try</span> {  

                    clientContext.Credentials = credentials;  

                    clientContext.Load(clientContext.Web);  

                    clientContext.ExecuteQuery();  

                    File oFile = clientContext.Web.GetFileByServerRelativeUrl(<span class="string">"/sites/TeamSite/SitePages/wikiPage.aspx"</span>);  

                    LimitedWebPartManager limitedWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);  

                    <span class="keyword">string</span> xmlWebPart = <span class="string">"&lt;?xml version=\"1.0\" encoding=\"utf-8\"?&gt;"</span> + <span class="string">"&lt;WebPart xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""</span> + <span class="string">" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""</span> + <span class="string">" xmlns=\"http://schemas.microsoft.com/WebPart/v2\"&gt;"</span> + <span class="string">"&lt;Title&gt;My Web Part&lt;/Title&gt;&lt;FrameType&gt;Default&lt;/FrameType&gt;"</span> + <span class="string">"&lt;Description&gt;Use for formatted text, tables, and images.&lt;/Description&gt;"</span> + <span class="string">"&lt;IsIncluded&gt;true&lt;/IsIncluded&gt;&lt;ZoneID&gt;&lt;/ZoneID&gt;&lt;PartOrder&gt;0&lt;/PartOrder&gt;"</span> + <span class="string">"&lt;FrameState&gt;Normal&lt;/FrameState&gt;&lt;Height /&gt;&lt;Width /&gt;&lt;AllowRemove&gt;true&lt;/AllowRemove&gt;"</span> + <span class="string">"&lt;AllowZoneChange&gt;true&lt;/AllowZoneChange&gt;&lt;AllowMinimize&gt;true&lt;/AllowMinimize&gt;"</span> + <span class="string">"&lt;AllowConnect&gt;true&lt;/AllowConnect&gt;&lt;AllowEdit&gt;true&lt;/AllowEdit&gt;"</span> + <span class="string">"&lt;AllowHide&gt;true&lt;/AllowHide&gt;&lt;IsVisible&gt;true&lt;/IsVisible&gt;&lt;DetailLink /&gt;&lt;HelpLink /&gt;"</span> + <span class="string">"&lt;HelpMode&gt;Modeless&lt;/HelpMode&gt;&lt;Dir&gt;Default&lt;/Dir&gt;&lt;PartImageSmall /&gt;"</span> + <span class="string">"&lt;MissingAssembly&gt;Cannot import this Web Part.&lt;/MissingAssembly&gt;"</span> + <span class="string">"&lt;PartImageLarge&gt;/_layouts/images/mscontl.gif&lt;/PartImageLarge&gt;&lt;IsIncludedFilter /&gt;"</span> + <span class="string">"&lt;Assembly&gt;Microsoft.SharePoint, Version=13.0.0.0, Culture=neutral, "</span> + <span class="string">"PublicKeyToken=94de0004b6e3fcc5&lt;/Assembly&gt;"</span> + <span class="string">"&lt;TypeName&gt;Microsoft.SharePoint.WebPartPages.ContentEditorWebPart&lt;/TypeName&gt;"</span> + <span class="string">"&lt;ContentLink xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\" /&gt;"</span> + <span class="string">"&lt;Content xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\"&gt;"</span> + <span class="string">"&lt;![CDATA[This is a first paragraph!&lt;DIV&gt; &lt;/DIV&gt;And this is a second paragraph.]]&gt;&lt;/Content&gt;"</span> + <span class="string">"&lt;PartStorage xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\" /&gt;&lt;/WebPart&gt;"</span>;  

                    WebPartDefinition oWebPartDefinition = limitedWebPartManager.ImportWebPart(xmlWebPart);  

                    limitedWebPartManager.AddWebPart(oWebPartDefinition.WebPart, <span class="string">"Left"</span>, 1);  

                    clientContext.ExecuteQuery();  

                } <span class="keyword">catch</span> (Exception e) {  

                    Console.WriteLine(e);  

                }  

            }  

            Console.WriteLine(<span class="string">"Succcesfully added webpart"</span>);  

        }  

    }  

}

using System;

using Microsoft.SharePoint.Client;

using Microsoft.SharePoint.Client.WebParts;

using System.Security;

namespace webpartadd {

class Program {

static void Main(string[] args) {

string userName = "userName@tenantName.onmicrosoft.com";

string password = "PassWord";

string siteUrl = "https://tenantName.sharepoint.com/sites/TeamSite";

SecureString securePassword = new SecureString();

foreach(char c in password) {

securePassword.AppendChar(c);

}

var credentials = new SharePointOnlineCredentials(userName, securePassword);

using(ClientContext clientContext = new ClientContext(siteUrl)) {

try {

clientContext.Credentials = credentials;

clientContext.Load(clientContext.Web);

clientContext.ExecuteQuery();

File oFile = clientContext.Web.GetFileByServerRelativeUrl("/sites/TeamSite/SitePages/wikiPage.aspx");

LimitedWebPartManager limitedWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);

string xmlWebPart = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" + "<WebPart xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" + " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"" + " xmlns=\"http://schemas.microsoft.com/WebPart/v2\">" + "<Title>My Web Part</Title><FrameType>Default</FrameType>" + "<Description>Use for formatted text, tables, and images.</Description>" + "<IsIncluded>true</IsIncluded><ZoneID></ZoneID><PartOrder>0</PartOrder>" + "<FrameState>Normal</FrameState><Height /><Width /><AllowRemove>true</AllowRemove>" + "<AllowZoneChange>true</AllowZoneChange><AllowMinimize>true</AllowMinimize>" + "<AllowConnect>true</AllowConnect><AllowEdit>true</AllowEdit>" + "<AllowHide>true</AllowHide><IsVisible>true</IsVisible><DetailLink /><HelpLink />" + "<HelpMode>Modeless</HelpMode><Dir>Default</Dir><PartImageSmall />" + "<MissingAssembly>Cannot import this Web Part.</MissingAssembly>" + "<PartImageLarge>/_layouts/images/mscontl.gif</PartImageLarge><IsIncludedFilter />" + "<Assembly>Microsoft.SharePoint, Version=13.0.0.0, Culture=neutral, " + "PublicKeyToken=94de0004b6e3fcc5</Assembly>" + "<TypeName>Microsoft.SharePoint.WebPartPages.ContentEditorWebPart</TypeName>" + "<ContentLink xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\" />" + "<Content xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\">" + "<![CDATA[This is a first paragraph!<DIV> </DIV>And this is a second paragraph.]]></Content>" + "<PartStorage xmlns=\"http://schemas.microsoft.com/WebPart/v2/ContentEditor\" /></WebPart>";

WebPartDefinition oWebPartDefinition = limitedWebPartManager.ImportWebPart(xmlWebPart);

limitedWebPartManager.AddWebPart(oWebPartDefinition.WebPart, "Left", 1);

clientContext.ExecuteQuery();

} catch (Exception e) {

Console.WriteLine(e);

}

Console.WriteLine("Succcesfully added webpart");

}

In the below image webpat is added in a wikipage,

Updating the web part in a wikipage

Step 1

First set the credentials by providing the user credentials.

Step 2

Using the client context, load the web.

Step 3

Get the object of the file using the server relative URL of the wiki page in which you want to add the web part. Example (/sites/team Site/Site Pages/wikiPage.aspx).

Step 4

Get the ‘limitedWebPartManager‘ by using object file.

Step 5

Load the web part using LINQ query expression to return only the title of each Web Part.

Step 6

Check the page having at least one web part for updating.

Step 7

Get the web part definition by using the order value.

Step 8

Change the web part Title then save the web part by calling ‘SaveWebPartChanges()‘.

Follow the below code snippet,

<span class="keyword">using</span> System;  

<span class="keyword">using</span> Microsoft.SharePoint.Client;  

<span class="keyword">using</span> Microsoft.SharePoint.Client.WebParts;  

<span class="keyword">using</span> System.Security;  

<span class="keyword">namespace</span> UpdateWebpart {  

    <span class="keyword">class</span> Program {  

        <span class="keyword">static</span> <span class="keyword">void</span> Main(<span class="keyword">string</span>[] args) {  

            <span class="keyword">string</span> userName = <span class="string">"userName@tenantName.onmicrosoft.com"</span>;  

            <span class="keyword">string</span> password = <span class="string">"PassWord"</span>;  

            <span class="keyword">string</span> siteUrl = <span class="string">"https://tenantName.sharepoint.com/sites/TeamSite"</span>;  

            SecureString securePassword = <span class="keyword">new</span> SecureString();  

            <span class="keyword">foreach</span>(<span class="keyword">char</span> c <span class="keyword">in</span> password) {  

                securePassword.AppendChar(c);  

            }  

            var cred = <span class="keyword">new</span> SharePointOnlineCredentials(userName, securePassword);  

            <span class="keyword">using</span>(ClientContext clientContext = <span class="keyword">new</span> ClientContext(siteUrl)) {  

                <span class="keyword">try</span> {  

                    clientContext.Credentials = cred;  

                    clientContext.Load(clientContext.Web);  

                    clientContext.ExecuteQuery();  

                    File oFile = clientContext.Web.GetFileByServerRelativeUrl(<span class="string">"/sites/TeamSite/SitePages/wikiPage.aspx"</span>);  

                    LimitedWebPartManager limitedWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);  

                    clientContext.Load(limitedWebPartManager.WebParts, wps =&gt; wps.Include(wp =&gt; wp.WebPart.Title));  

                    clientContext.ExecuteQuery();  

                    <span class="keyword">if</span> (limitedWebPartManager.WebParts.Count == 0) {  

                        <span class="keyword">throw</span> <span class="keyword">new</span> Exception(<span class="string">"No Web Parts on this page."</span>);  

                    }  

                    WebPartDefinition oWebPartDef = limitedWebPartManager.WebParts[0];  

                    WebPart oWebPart = oWebPartDef.WebPart;  

                    oWebPart.Title = <span class="string">"New WebPart Title"</span>;  

                    oWebPartDef.SaveWebPartChanges();  

                    clientContext.ExecuteQuery();  

                } <span class="keyword">catch</span> (Exception e) {  

                    Console.WriteLine(e);  

                }  

            }  

            Console.WriteLine(<span class="string">"Succcesfully updated webpart"</span>);  

        }  

    }  

}

using System;

using Microsoft.SharePoint.Client;

using Microsoft.SharePoint.Client.WebParts;

using System.Security;

namespace UpdateWebpart {

class Program {

static void Main(string[] args) {

string userName = "userName@tenantName.onmicrosoft.com";

string password = "PassWord";

string siteUrl = "https://tenantName.sharepoint.com/sites/TeamSite";

SecureString securePassword = new SecureString();

foreach(char c in password) {

securePassword.AppendChar(c);

}

var cred = new SharePointOnlineCredentials(userName, securePassword);

using(ClientContext clientContext = new ClientContext(siteUrl)) {

try {

clientContext.Credentials = cred;

clientContext.Load(clientContext.Web);

clientContext.ExecuteQuery();

File oFile = clientContext.Web.GetFileByServerRelativeUrl("/sites/TeamSite/SitePages/wikiPage.aspx");

LimitedWebPartManager limitedWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);

clientContext.Load(limitedWebPartManager.WebParts, wps => wps.Include(wp => wp.WebPart.Title));

clientContext.ExecuteQuery();

if (limitedWebPartManager.WebParts.Count == 0) {

throw new Exception("No Web Parts on this page.");

}

WebPartDefinition oWebPartDef = limitedWebPartManager.WebParts[0];

WebPart oWebPart = oWebPartDef.WebPart;

oWebPart.Title = "New WebPart Title";

oWebPartDef.SaveWebPartChanges();

clientContext.ExecuteQuery();

} catch (Exception e) {

Console.WriteLine(e);

}

Console.WriteLine("Succcesfully updated webpart");

}

In the below image web pat title is update in a wikipage,

Removing the web part from a wikipage

Step 1

First set the credentials by providing the user credentials.

Step 2

Using the client context and, load the web.

Step 3

Get the object of the file using server relative URL of the wiki page in which you want to add the web part. Example (/sites/team Site/Site Pages/wikiPage.aspx).

Step 4

Get the ‘limitedWebPartManager‘ by using object file.

Step 5

Load the web part.

Step 6

Check the page having at least one web part for deleting.

Step 7

Get the web part definition by using the order value.

Step 8

Delete the web part by calling ‘DeleteWebPart ()‘.

Follow the below code snippet,

using System;  

using Microsoft.SharePoint.Client;  

using Microsoft.SharePoint.Client.WebParts;  

using System.Security;  

namespace RemoveWebpart {  

    class Program {  

        static void Main(string[] args) {  

            string userName = "userName@tenantName.onmicrosoft.com";  

            string password = "PassWord";  

            string siteUrl = "https://tenantName.sharepoint.com/sites/TeamSite";  

            SecureString securePassword = new SecureString();  

            foreach(char c in password) {  

                securePassword.AppendChar(c);  

            }  

            var cred = new SharePointOnlineCredentials(userName, securePassword);  

            using(ClientContext clientContext = new ClientContext(siteUrl)) {  

                try {  

                    clientContext.Credentials = cred;  

                    clientContext.Load(clientContext.Web);  

                    clientContext.ExecuteQuery();  

                    File oFile = clientContext.Web.GetFileByServerRelativeUrl("/sites/TeamSite/SitePages/wikiPage.aspx");  

                    LimitedWebPartManager ltdWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);  

                    clientContext.Load(ltdWebPartManager.WebParts);  

                    clientContext.ExecuteQuery();  

                    if (ltdWebPartManager.WebParts.Count == 0) {  

                        throw new Exception("No Web Parts to delete.");  

                    }  

                    WebPartDefinition webPartDef = ltdWebPartManager.WebParts[0];  

                    webPartDef.DeleteWebPart();  

                    clientContext.ExecuteQuery();  

                } catch (Exception e) {  

                    Console.WriteLine(e);  

                }  

                Console.WriteLine("Succcesfully deleted webpart");  

            }  

        }  

    }  

}

using System;

using Microsoft.SharePoint.Client;

using Microsoft.SharePoint.Client.WebParts;

using System.Security;

namespace RemoveWebpart {

class Program {

static void Main(string[] args) {

string userName = "userName@tenantName.onmicrosoft.com";

string password = "PassWord";

string siteUrl = "https://tenantName.sharepoint.com/sites/TeamSite";

SecureString securePassword = new SecureString();

foreach(char c in password) {

securePassword.AppendChar(c);

}

var cred = new SharePointOnlineCredentials(userName, securePassword);

using(ClientContext clientContext = new ClientContext(siteUrl)) {

try {

clientContext.Credentials = cred;

clientContext.Load(clientContext.Web);

clientContext.ExecuteQuery();

File oFile = clientContext.Web.GetFileByServerRelativeUrl("/sites/TeamSite/SitePages/wikiPage.aspx");

LimitedWebPartManager ltdWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared);

clientContext.Load(ltdWebPartManager.WebParts);

clientContext.ExecuteQuery();

if (ltdWebPartManager.WebParts.Count == 0) {

throw new Exception("No Web Parts to delete.");

}

WebPartDefinition webPartDef = ltdWebPartManager.WebParts[0];

webPartDef.DeleteWebPart();

clientContext.ExecuteQuery();

} catch (Exception e) {

Console.WriteLine(e);

}

Console.WriteLine("Succcesfully deleted webpart");

}

In the below image web pat is deleted from the wikipage,

SharePoint 2013 Hosting – HostForLIFE :: Add, Update And Remove Web Part Using CSOM

Introduction

Adding the web part in a wikipage

Updating the web part in a wikipage

Removing the web part from a wikipage

BLOGROLL

Featured On

SharePoint 2013 Hosting – HostForLIFE :: Add, Update And Remove Web Part Using CSOM

Introduction

Adding the web part in a wikipage

Updating the web part in a wikipage

Removing the web part from a wikipage

BLOGROLL

Featured On

Tags