public static void AddSectionAndAddWebpart()
{
OfficeDevPnP.Core.AuthenticationManager authenticationManager = new OfficeDevPnP.Core.AuthenticationManager();
using (binderSiteClientContext = authenticationManager.GetSharePointOnlineAuthenticatedContextTenant(binderSiteUrl, userName, passWord))
{
//Create a page or get the existing page
string pageName = "POCSiteProvisioning.aspx";
ClientSidePage page = ClientSidePage.Load(binderSiteClientContext, pageName);
//var page = binderSiteClientContext.Web.AddClientSidePage("POCAppProvisioning.aspx", true);
// Add Section
page.AddSection(CanvasSectionTemplate.ThreeColumn, 5);
// get the available web parts - this collection will include OOTB and custom SPFx web parts..
page.Save();
// Get all the available webparts
var components = page.AvailableClientSideComponents();
// add the named web part..
var webPartToAdd = components.Where(wp => wp.ComponentType == 1 && wp.Name == "HeroControl").FirstOrDefault();
if (webPartToAdd != null)
{
ClientSideWebPart clientWp = new ClientSideWebPart(webPartToAdd) { Order = 1 };
//Add the WebPart to the page with appropriate section
page.AddControl(clientWp, page.Sections[1].Columns[1]);
}
// the save method creates the page if one doesn't exist with that name in this site..
page.Save();
}
}
public static void CreatePage(ClientContext ctx)
{
var oldpage = ctx.Web.LoadClientSidePage("david2.aspx");
oldpage.Delete();
ctx.ExecuteQuery();
List carsList = ctx.Web.GetListByTitle("Cars");
ctx.Load(ctx.Web);
ctx.ExecuteQuery();
var page = ctx.Web.AddClientSidePage("david2.aspx", true);
page.PageTitle = "Davids Page";
page.AddSection(CanvasSectionTemplate.TwoColumn, 1);
page.AddSection(CanvasSectionTemplate.ThreeColumn, 2);
var components = page.AvailableClientSideComponents();
var component = components.Where(c => c.Name == "e377ea37-9047-43b9-8cdb-a761be2f8e09").FirstOrDefault();
ClientSideWebPart wp = new ClientSideWebPart(component);
// page.AddControl(wp, -1);
var column = page.Sections[1].Columns[2];
page.AddControl(wp, column, 1);
var props = "{'isDocumentLibrary':false,'selectedListId':'" + carsList.Id.ToString() + "','listTitle':'Cars','selectedListUrl':'" + ctx.Web.ServerRelativeUrl + "/Lists/cars','webRelativeListUrl':'/Lists/cars','webpartHeightKey':4}";
var ListComponent = components.Where(c => c.Name == "f92bf067-bc19-489e-a556-7fe95f508720").FirstOrDefault();
ClientSideWebPart wp2 = new ClientSideWebPart(ListComponent);
wp2.PropertiesJson = props;
var column2 = page.Sections[0].Columns[1];
page.AddControl(wp2, column2, 1);
page.Save();
ctx.ExecuteQuery();
}
private static void AddCustomSPFxWebPart(ClientContext siteContext, string wpName, string pageName, int wpOrder)
{
ClientSidePage page = new ClientSidePage(siteContext);
var components = page.AvailableClientSideComponents();
var webPartToAdd = components.Where(wp => wp.ComponentType == 1 && wp.Name == wpName).FirstOrDefault();
if (webPartToAdd != null)
{
ClientSideWebPart clientWp = new ClientSideWebPart(webPartToAdd)
{
Order = wpOrder
};
page.AddControl(clientWp);
}
page.Save(pageName);
}
private static void AddDefaultWebPart(ClientContext siteContext, string pageName)
{
// add video embed web part..
ClientSidePage page = new ClientSidePage(siteContext);
ClientSideWebPart videoEmbedWp = page.InstantiateDefaultWebPart(DefaultClientSideWebParts.VideoEmbed);
videoEmbedWp.Properties["videoSource"] = "[specify-url-here]";
videoEmbedWp.Properties["captionText"] = "[specify-title-here]";
videoEmbedWp.Properties["showInfo"] = false;
videoEmbedWp.Properties["embedCode"] = "<iframe width=853 height=480 src='[specify-url-here]' allowfullscreen></iframe>";
videoEmbedWp.Title = "Associated video";
page.AddControl(videoEmbedWp);
// add Yammer embed web part..
ClientSideWebPart yammerEmbedWp = page.InstantiateDefaultWebPart(DefaultClientSideWebParts.YammerEmbed);
yammerEmbedWp.Properties["yammerFeedURL"] = "[specify-url-here]";
yammerEmbedWp.Title = "Associated Yammer group";
page.AddControl(yammerEmbedWp);
page.Save(pageName);
Console.WriteLine("Default Web Part added.");
}
protected override void ExecuteCmdlet()
{
if (MyInvocation.BoundParameters.ContainsKey("Section") && Section == 0)
{
throw new Exception("Section value should be at least 1 or higher");
}
if (MyInvocation.BoundParameters.ContainsKey("Column") && Column == 0)
{
throw new Exception("Column value should be at least 1 or higher");
}
var clientSidePage = Page.GetPage(ClientContext);
// If the client side page object cannot be found
if (clientSidePage == null)
{
throw new Exception($"Page {Page} cannot be found.");
}
ClientSideWebPart webpart = null;
if (MyInvocation.BoundParameters.ContainsKey("DefaultWebPartType"))
{
webpart = clientSidePage.InstantiateDefaultWebPart(DefaultWebPartType);
}
else
{
webpart = new ClientSideWebPart(Component.GetComponent(clientSidePage));
}
if (WebPartProperties != null)
{
if (WebPartProperties.Properties != null)
{
webpart.Properties.Merge(WebPartProperties.JsonObject);
}
else if (!string.IsNullOrEmpty(WebPartProperties.Json))
{
webpart.PropertiesJson = WebPartProperties.Json;
}
}
if (MyInvocation.BoundParameters.ContainsKey("Section"))
{
if (MyInvocation.BoundParameters.ContainsKey("Column"))
{
clientSidePage.AddControl(webpart,
clientSidePage.Sections[Section - 1].Columns[Column - 1], Order);
}
else
{
clientSidePage.AddControl(webpart, clientSidePage.Sections[Section - 1], Order);
}
}
else
{
clientSidePage.AddControl(webpart, Order);
}
clientSidePage.Save();
}
public static void PageSectionDivision()
{
OfficeDevPnP.Core.AuthenticationManager authenticationManager = new OfficeDevPnP.Core.AuthenticationManager();
using(ClientContext currentSiteContext = authenticationManager.GetSharePointOnlineAuthenticatedContextTenant(binderSiteUrl, userName, passWord)) {
string pageName = "POCSiteProvisioning.aspx";
ClientSidePage page = ClientSidePage.Load(currentSiteContext, pageName);
var appManager = new AppManager(currentSiteContext);
var apps = appManager.GetAvailable();
ClientSideComponent clientSideComponent = null;
var chartsApp = apps.Where(a => a.Title == "hero-control-client-side-solution-ProductionEnv").FirstOrDefault();
bool controlPresent = false;
bool done = false;
int count = 0;
do
{
try
{
ClientSideComponent[] clientSideComponents = (ClientSideComponent[])page.AvailableClientSideComponents();
clientSideComponent = clientSideComponents.Where(c => c.Id.ToLower() == chartsApp.Id.ToString().ToLower()).FirstOrDefault();
foreach (ClientSideComponent csc in clientSideComponents)
{
if (csc.Id.ToString().ToLower().Contains(chartsApp.Id.ToString().ToLower()))
{
clientSideComponent = csc;
continue;
}
}
//ClientSideWebPart webPart = page.Controls.Where(wP => wP != null)
foreach (var control in page.Controls)
{
ClientSideWebPart cpWP = control as ClientSideWebPart;
if (cpWP != null && cpWP.SpControlData.WebPartId.ToString() == chartsApp.Id.ToString())
{
controlPresent = true;
done = true;
}
}
if (!controlPresent)
{
ClientSideWebPart WebPart = new ClientSideWebPart(clientSideComponent);
JToken activeValueToken = true;
// Find the web part configuration string from the web part file or code debugging
//string propertyJSONString = String.Format("[{{<WP Configuration string>}}]", < parameters >);
//JToken propertyTermToken = JToken.Parse(propertyJSONString);
WebPart.Properties.Add("showOnlyActive", activeValueToken);
CanvasSection section = new CanvasSection(page, CanvasSectionTemplate.ThreeColumnVerticalSection, page.Sections.Count + 1);
page.Sections.Add(section);
page.Save();
page.AddControl(WebPart, section.Columns[0]);
page.Save();
page.Publish();
done = true;
controlPresent = true;
}
}
catch (Exception ex)
{
//Log.Info("Catched exception while adding Capex web part.. Trying again" + ex.Message);
Console.WriteLine(ex);
Console.ReadLine();
count++;
}
} while (!done && count <= 5);
}
}
static void Main(string[] args)
{
// Update the below variables to use your tenant and account information
//string siteUrl = "https://contoso.sharepoint.com/sites/modernpagedemo";
//string userName = "******";
string siteUrl = "https://bertonline.sharepoint.com/sites/bert1";
string userName = "******";
SecureString password = GetSecureString("Password");
AuthenticationManager am = new AuthenticationManager();
using (var cc = am.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userName, password))
{
#region Previous demos
/*
* // Demo 1: Add empty page
* var page = cc.Web.AddClientSidePage("PnPRocks.aspx", true);
*
* // Demo 2: Read existing page and Text control + custom web part.
* // Important: manually create a sample modern page called "Templatepage" in your demo site first
* ClientSidePage p = ClientSidePage.Load(cc, "Demo.aspx");
* // Add text control on top
* ClientSideText txt1 = new ClientSideText() { Text = "PnP Rocks" };
* p.AddControl(txt1, -1);
* // Find custom component and add as last control
* // Important: this assumes you've a custom client side web part with name "HelloWorld" deployed to the test site collection.
* var components = p.AvailableClientSideComponents();
* var myWebPart = components.Where(s => s.Name == "HelloWorld").FirstOrDefault();
* if (myWebPart != null)
* {
* ClientSideWebPart helloWp = new ClientSideWebPart(myWebPart) { Order = 10 };
* p.AddControl(helloWp);
* }
* // Save the page under a new name
* p.Save("pagewithcontrols.aspx");
*
* //Demo 3: Add OOB web part (Image)
* // Important: if you don't update the web part properties your client side impage web part will not be able to load the image
* ClientSidePage page5 = new ClientSidePage(cc);
* var imageWebPart = page5.InstantiateDefaultWebPart(DefaultClientSideWebParts.Image);
* imageWebPart.Properties["imageSourceType"] = 2;
* imageWebPart.Properties["siteId"] = "c827cb03-d059-4956-83d0-cd60e02e3b41";
* imageWebPart.Properties["webId"] = "9fafd7c0-e8c3-4a3c-9e87-4232c481ca26";
* imageWebPart.Properties["listId"] = "78d1b1ac-7590-49e7-b812-55f37c018c4b";
* imageWebPart.Properties["uniqueId"] = "3C27A419-66D0-4C36-BF24-BD6147719052";
* imageWebPart.Properties["imgWidth"] = 1002;
* imageWebPart.Properties["imgHeight"] = 469;
* //imageWebPart.PropertiesJson = "{\"imageSourceType\":2,\"altText\":\"\",\"fileName\":\"\",\"siteId\":\"c827cb03-d059-4956-83d0-cd60e02e3b41\",\"webId\":\"9fafd7c0-e8c3-4a3c-9e87-4232c481ca26\",\"listId\":\"78d1b1ac-7590-49e7-b812-55f37c018c4b\",\"uniqueId\":\"{3C27A419-66D0-4C36-BF24-BD6147719052}\",\"imgWidth\":1002,\"imgHeight\":469}";
* page5.AddControl(imageWebPart);
* page5.Save("pagewithimage.aspx");
*
* //Demo 4: delete page
* ClientSidePage p2 = ClientSidePage.Load(cc, "pagewithcontrols.aspx");
* p2.Delete();
*
* //Demo 5: delete control
* ClientSidePage deleteDemoPage = ClientSidePage.Load(cc, "pagewithimage.aspx");
* deleteDemoPage.Controls[0].Delete();
* deleteDemoPage.Save();
*/
#endregion
//Demo 6: create a page with a flexible page layout
var page2 = cc.Web.AddClientSidePage("PageWithSections.aspx", true);
page2.AddZone(CanvasZoneTemplate.ThreeColumn, 5);
page2.AddZone(CanvasZoneTemplate.TwoColumn, 10);
var componentsToAdd = page2.AvailableClientSideComponents();
var myHellowWorldWebPart = componentsToAdd.Where(s => s.Name == "HelloWorld").FirstOrDefault();
if (myHellowWorldWebPart != null)
{
ClientSideText text = new ClientSideText()
{
Text = "Text control in first zone, left column"
};
page2.AddControl(text, page2.Zones[0]);
ClientSideWebPart helloWp = new ClientSideWebPart(myHellowWorldWebPart)
{
Order = 10
};
helloWp.Properties["description"] = "Hello world from control 1!!";
helloWp.Properties["test3"] = false;
helloWp.Properties["test2"] = "1";
//description":"HelloWorld","test":"Multi-line text field","test1":true,"test2":"2","test3":true
page2.AddControl(helloWp, page2.Zones[0].Sections[2]);
ClientSideWebPart helloWp2 = new ClientSideWebPart(myHellowWorldWebPart)
{
Order = 10
};
helloWp2.Properties["description"] = "Hello world from control 2!!";
helloWp2.Properties["test3"] = true;
helloWp2.Properties["test2"] = "3";
//description":"HelloWorld","test":"Multi-line text field","test1":true,"test2":"2","test3":true
page2.AddControl(helloWp2, page2.Zones[1]);
}
page2.Save();
// Demo 7: read created page and flip the order of the sections, move web parts around and turn off commenting
var page3 = cc.Web.LoadClientSidePage("PageWithSections.aspx");
// Move web part
page3.Zones[0].Sections[0].Controls[0].Move(page3.Zones[0].Sections[2], 20);
// Move zones
page3.Zones[0].Order = 10;
page3.Zones[1].Order = 5;
ClientSideText text2 = new ClientSideText()
{
Text = "Text control in first zone, middle column"
};
page3.AddControl(text2, page3.Zones[0].Sections[1]);
page3.Save();
// Disable comments for this page
page3.DisableComments();
// Demo 8: create a news page
ClientSidePage page4 = new ClientSidePage(cc);
page4.AddZone(CanvasZoneTemplate.TwoColumn, 10);
ClientSideText text4 = new ClientSideText()
{
Text = "Hello all, this is our first news page."
};
page4.AddControl(text4);
var imageWebPart4 = page4.InstantiateDefaultWebPart(DefaultClientSideWebParts.Image);
imageWebPart4.Properties["imageSourceType"] = 2;
imageWebPart4.Properties["siteId"] = "c827cb03-d059-4956-83d0-cd60e02e3b41";
imageWebPart4.Properties["webId"] = "9fafd7c0-e8c3-4a3c-9e87-4232c481ca26";
imageWebPart4.Properties["listId"] = "78d1b1ac-7590-49e7-b812-55f37c018c4b";
imageWebPart4.Properties["uniqueId"] = "3C27A419-66D0-4C36-BF24-BD6147719052";
imageWebPart4.Properties["imgWidth"] = 500;
imageWebPart4.Properties["imgHeight"] = 235;
//imageWebPart.PropertiesJson = "{\"imageSourceType\":2,\"altText\":\"\",\"fileName\":\"\",\"siteId\":\"c827cb03-d059-4956-83d0-cd60e02e3b41\",\"webId\":\"9fafd7c0-e8c3-4a3c-9e87-4232c481ca26\",\"listId\":\"78d1b1ac-7590-49e7-b812-55f37c018c4b\",\"uniqueId\":\"{3C27A419-66D0-4C36-BF24-BD6147719052}\",\"imgWidth\":1002,\"imgHeight\":469}";
page4.AddControl(imageWebPart4, page4.DefaultZone.Sections[1]);
page4.Save("newspage.aspx");
// promote as news
page4.PromoteAsNewsArticle();
// Demo 9: give the site a new home page
var newHomePage = cc.Web.AddClientSidePage();
newHomePage.LayoutType = ClientSidePageLayoutType.Home;
newHomePage.AddZone(CanvasZoneTemplate.ThreeColumn, 10);
newHomePage.AddControl(new ClientSideText()
{
Text = "Having a custom home page"
}, newHomePage.DefaultZone);
newHomePage.AddControl(new ClientSideText()
{
Text = "with multiple columns"
}, newHomePage.DefaultZone.Sections[1]);
newHomePage.AddControl(new ClientSideText()
{
Text = "is possible :-)"
}, newHomePage.DefaultZone.Sections[2]);
newHomePage.Save("Home_2.aspx");
newHomePage.PromoteAsHomePage();
// Demo 10: restore original home page
cc.Web.LoadClientSidePage("Home.aspx").PromoteAsHomePage();
}
}
static void Main(string[] args)
{
// Update the below variables to use your tenant and account information
string siteUrl = "https://contoso.sharepoint.com/sites/modernpagedemo";
string userName = "******";
SecureString password = GetSecureString("Password");
AuthenticationManager am = new AuthenticationManager();
using (var cc = am.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userName, password))
{
// Demo 1: Add empty page
var page = cc.Web.AddClientSidePage("PnPRocks.aspx", true);
// Demo 2: Read existing page and Text control + custom web part.
// Important: manually create a sample modern page called "Templatepage" in your demo site first
ClientSidePage p = ClientSidePage.Load(cc, "Templatepage.aspx");
// Add text control on top
ClientSideText txt1 = new ClientSideText()
{
Text = "PnP Rocks"
};
p.AddControl(txt1, -1);
// Find custom component and add as last control
// Important: this assumes you've a custom client side web part with name "HelloWorld" deployed to the test site collection.
var components = p.AvailableClientSideComponents();
var myWebPart = components.Where(s => s.Name == "HelloWorld").FirstOrDefault();
if (myWebPart != null)
{
ClientSideWebPart helloWp = new ClientSideWebPart(myWebPart)
{
Order = 10
};
p.AddControl(helloWp);
}
// Save the page under a new name
p.Save("pagewithcontrols.aspx");
//Demo 3: Add OOB web part (Image)
// Important: if you don't update the web part properties your client side impage web part will not be able to load the image
ClientSidePage page5 = new ClientSidePage(cc);
var imageWebPart = page5.InstantiateDefaultWebPart(DefaultClientSideWebParts.Image);
imageWebPart.Properties["imageSourceType"] = 2;
imageWebPart.Properties["siteId"] = "c827cb03-d059-4956-83d0-cd60e02e3b41";
imageWebPart.Properties["webId"] = "9fafd7c0-e8c3-4a3c-9e87-4232c481ca26";
imageWebPart.Properties["listId"] = "78d1b1ac-7590-49e7-b812-55f37c018c4b";
imageWebPart.Properties["uniqueId"] = "3C27A419-66D0-4C36-BF24-BD6147719052";
imageWebPart.Properties["imgWidth"] = 1002;
imageWebPart.Properties["imgHeight"] = 469;
//imageWebPart.PropertiesJson = "{\"imageSourceType\":2,\"altText\":\"\",\"fileName\":\"\",\"siteId\":\"c827cb03-d059-4956-83d0-cd60e02e3b41\",\"webId\":\"9fafd7c0-e8c3-4a3c-9e87-4232c481ca26\",\"listId\":\"78d1b1ac-7590-49e7-b812-55f37c018c4b\",\"uniqueId\":\"{3C27A419-66D0-4C36-BF24-BD6147719052}\",\"imgWidth\":1002,\"imgHeight\":469}";
page5.AddControl(imageWebPart);
page5.Save("pagewithimage.aspx");
//Demo 4: delete page
ClientSidePage p2 = ClientSidePage.Load(cc, "pagewithcontrols.aspx");
p2.Delete();
//Demo 5: delete control
ClientSidePage deleteDemoPage = ClientSidePage.Load(cc, "pagewithimage.aspx");
deleteDemoPage.Controls[0].Delete();
deleteDemoPage.Save();
}
}
private void UpdateFile(string cFileName)
{
try
{
ClientSidePage page = ClientSidePage.Load(ctx, "Home.aspx");
ClientSidePage newPage = new ClientSidePage(ctx, ClientSidePageLayoutType.Home);
foreach (CanvasControl ctrl in page.Controls)
{
System.Diagnostics.Trace.WriteLine(ctrl.ToString());
newPage.Controls.Add(ctrl);
}
newPage.Save("NewHome.aspx");
ctx.ExecuteQuery();
ClientSideComponent c = GetComponent(page, "EtcContentDisplayWebPart");
if (c!=null)
{
ClientSideWebPart csWebPart = new ClientSideWebPart(c);
page.Controls.Add(csWebPart);
page.Save();
ctx.ExecuteQuery();
}
//foreach(ClientSideComponent csc in comps)
//{
// dynamic data = JObject.Parse(csc.Manifest);
// string alias = data.alias;
// string componentType = data.componentType;
// string isInternal = data.isInternal;
// System.Diagnostics.Trace.WriteLine(componentType +" - "+isInternal+" - "+alias);
// if (csc.Manifest.Contains("Content Display"))
// {
// System.Diagnostics.Trace.WriteLine(csc.Name+" -"+csc.Status+" - "+csc.ManifestType);
// }
//}
System.Diagnostics.Trace.WriteLine("");
}
catch (Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
}
