Skip to main content

Create a Web Part Page Programmatically

When creating SharePoint Solutions we need to deploy Web part pages with the solution. I'm sure most of us deploy pages as a module. But we are copying aspx page from some ware else and include it to module. (Visual studio does not allow to create web part aspx pages in SharePoint Solutions) 

So I think it is good to use a method to create web part pages rather than copying from somewhere else and put it to the solution. Using below method you can add web part page to document library with  specified template. of cause you can add custom template ; in that case you can deploy custom template first and use the following method to create a web part page.

First you need to generate the XML for add Web Part Page 

private string GetCreateWebPartPage(String list, string pageTitle, int layoutTemplate)
{
   const string newItemTemplate = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
                                  "<Batch>" +
                                  "<Method ID=\"0,NewWebPage\">" +
                                   "<SetList Scope=\"Request\">{0}</SetList>" +
                                   "<SetVar Name=\"Cmd\">NewWebPage</SetVar>" +
                                   "<SetVar Name=\"ID\">New</SetVar>" +
                                   "<SetVar Name=\"Type\">WebPartPage</SetVar>" +
                                   "<SetVar Name=\"WebPartPageTemplate\">{2}</SetVar>" +
                                   "<SetVar Name=\"Overwrite\">true</SetVar>" +
                                   "<SetVar Name=\"Title\">{1}</SetVar>" +
                                   "</Method>" +
                                    "</Batch>";
   var newItemXml = string.Format(newItemTemplate, list, pageTitle, layoutTemplate); 

   return newItemXml;
}


Then Pass it to ProcessBatchData method in SPWeb to create the page.


using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
   string xml = GetCreateWebPartPage("SitePages", "SamplePage", 2);
   oWebsite.ProcessBatchData();
}



You can put the code in Feature Activation for deployment.

Labels:

Comments

Post a Comment

Popular posts from this blog

Complete guide to Install SharePoint in a Three Server Farm using AutpSPInstaller

This article will be divided to three sections Setting up the Environment and Service Accounts Getting Ready with AutoSPInstaller Online Configuring the XML using Online Editor and Installation Setting up the Environment and Service Accounts AutoSPInstaller Online is one of a great project that facilitate Automated SharePoint installation including Sharepoint 2010, 2013 and 2016. Auto SP Installer provides a powerful way to deploy and configure a single-server development environment to multiple-server SharePoint farm. Reference: https://autospinstaller.com/ Before doing anything we will set up the environment for SharePoint three server Farm. Will name these servers as SPWFE - Share Point Front End Server SPAPP - Share Point App server SPDB - DB server Please find the reference for SharePoint minimum requirement and practices from https://docs.microsoft.com/en-us/SharePoint/install/install-sharepoint-server-2016-across-multiple-servers For the the medium segregation, we have to create...
Post a Comment
Read more

How to Customize New Item Form to take parameters from Query String in the SharePoint 2010

In here I'm going to explain how to customize the SharePoint Item From to take parameters from Query String and set them as default values using SharePoint designer. Using this you can open a new Item From by providing parameters as query string. For an example you can customize one item Display form and taking query String Parameter from that and view New Item view for another list by providing default values using the Query String.     Steps Open the SharePoint designer and go to list and libraries and open the list that you want. Click the New and create a New Insert View by providing the name of the view.   Then created one will come to the list. then click and open the view. Then default New Item Screen will be loaded as follows. Then Delete the default list view and make that empty. You can delete the controls by selecting the area in the design view, If it fully cleared you can view the following message from the designer. Then go to SharePoint...
6 comments
Read more

Motion Eye Docker compose File

Docker compose files are comes in handy when considering container orchestration. Below example shows my docker compose files and folder structure. ---- Your Folder (motioneye)   -- etc   -- lib   -- docker-compose.yaml You can run the docker compose file using docker-compose -d , and etc and lib folder will be automatically populated in the initiation. --- Below shows the content of the docker-compose.yaml file. version: '3' services:   nodered:    image: "ccrisan/motioneye:master-amd64"    container_name: motioneye    restart: always    user: root    ports:      - 8765:8765    volumes:      - "/etc/localtime:/etc/localtime:ro"      - "./etc:/etc/motioneye"      - "./lib:/var/lib/motioneye"
Post a Comment
Read more