How to: Deploy a Page using a Feature

Posted Tuesday, June 2, 2009 3:58 PM by CoreyRoth

I am about to do start giving some training again, so I thought I would work on some more content for the blog that I could refer to people to when they are trying things out.  Today, I want to start out with the basic task of deploying a page to SharePoint.  There are actually lots of ways to get pages into SharePoint.  You can use the whole page publishing model in MOSS, but sometimes you just need a simple page with a simple web part deployed and a feature makes this task pretty easy.

For today’s example, I want to deploy a simple page with a web part or two on it.  To start, you will need to create a new folder for your feature.  You can name this whatever you want.  For the purpose of this example, we’ll call it PageTest.  Before we begin though we need a .aspx page which will host these web parts.  You can create one on your own, but I find it’s easiest to just “borrow” one from SharePoint that already exists.  A good one to borrow I have found is in the STS site template (12\TEMPLATE\SiteTemplate\STS) called default.aspx.  This .aspx page has two WebPartZones named Left and Right.  Put a copy of this file into your new feature folder.  You can customize this file however you desire, such as changing the layout or adding or subtracting WebPartZones.

By now, I am sure you probably know how to make a basic Feature.xml file, but here is one just in case.  In this case, we have a feature with a scope of Web so we’ll be deploying to an individual site.







    Description="Deploys a custom page with some web parts."



    <ElementManifest Location="elements.xml" />



The Elements.xml file deploys files using the Module and File elements.  The Module element tells SharePoint to deploy files from a physical folder, specified in the Path attribute, to a virtual folder inside SharePoint, specified in the Url attribute.  The Path attribute is relative to the feature folder while the Url attribute is relative to the site it was deployed on.  No paths are specified in our case.

<Module Name="Pages" Path="" Url="">

The Module element can contain one or more File elements to deploy pages.  You need one File element for each page you want to deploy inside of SharePoint.  Note: that it is possible to use the same default.aspx page in your feature folder and deploy it multiple times with different web parts (i.e.: page1.aspx, page2.aspx, etc.).

<File Name="TestPage.aspx" Url="default.aspx" IgnoreIfAlreadyExists="FALSE" NavBarHome="True">

The Name attribute specifies the name the file will be called inside SharePoint.  The Url specifies the name of the file in your feature folder.  In our case, default.aspx.  The confusing part her of course being that Url in the Module element refers to the path inside SharePoint and on the File element it refers to the name of the file in your feature folder.

For each page that you can deploy, you can use CAML to automatically add web parts to the page.  To do this, you use the AllUsersWebPart element.  Remember in the page we had WebPartZones named Left and Right?  We use those same Ids here, to specify which zone to add the web part too.  The WebPartZoneOrder element specifies the order in which the web parts are added to a given zone (you can have multiple web parts in a zone and they will stack).  The definition of the web part goes inside a CDATA element inside the AllUsersWebPart element.  If you built the web part yourself, you can just paste in the XML from your .webpart file.  If you are using an out-of-the-box SharePoint web part, you can add it to an existing page and export it or go to the web part gallery and export it.  Here is what a completed file looks like with multiple web parts.

<Elements xmlns="">

  <Module Name="Pages" Path="" Url="">

    <File Name="TestPage.aspx" Url="default.aspx" IgnoreIfAlreadyExists="FALSE" NavBarHome="True">

      <AllUsersWebPart WebPartZoneID="Left" WebPartOrder="1">



            <webPart xmlns="">


                <type name="MyWebPart.TestWebPart, MyWebPart, Version=, Culture=neutral" />

                <importErrorMessage>Cannot import this Web Part.</importErrorMessage>




                  <property name="Title" type="string">My Web Part</property>

                  <property name="Description" type="string">A test web part.</property>







      <AllUsersWebPart WebPartZoneID="Left" WebPartOrder="2">


        <WebPart xmlns:xsi="" xmlns:xsd="" xmlns="">

          <Title>Search Box</Title>

          <Description>Used to search document and items.</Description>

          <MissingAssembly>Cannot import this Web Part.</MissingAssembly>

          <Assembly>Microsoft.SharePoint.Portal, Version=, Culture=neutral, PublicKeyToken=71e9bce111e9429c</Assembly>


          <GoImageUrl xmlns="urn:schemas-microsoft-com:SearchBoxEx">/_layouts/images/gosearch.gif</GoImageUrl>

          <GoImageUrlRTL xmlns="urn:schemas-microsoft-com:SearchBoxEx">/_layouts/images/goRTL.gif</GoImageUrlRTL>

          <GoImageActiveUrl xmlns="urn:schemas-microsoft-com:SearchBoxEx">/_layouts/images/gosearch.gif</GoImageActiveUrl>

          <GoImageActiveUrlRTL xmlns="urn:schemas-microsoft-com:SearchBoxEx">/_layouts/images/goRTL.gif</GoImageActiveUrlRTL>

          <DropDownModeEx xmlns="urn:schemas-microsoft-com:SearchBoxEx">ShowDD</DropDownModeEx>

          <ScopeDisplayGroupName xmlns="urn:schemas-microsoft-com:SearchBoxEx">Search Dropdown</ScopeDisplayGroupName>

          <RegisterStyles xmlns="urn:schemas-microsoft-com:SearchBoxEx">true</RegisterStyles>

          <ShouldTakeFocusIfEmpty xmlns="urn:schemas-microsoft-com:SearchBoxEx">false</ShouldTakeFocusIfEmpty>




      <AllUsersWebPart WebPartZoneID="Right" WebPartOrder="1">


                   <WebPart xmlns="" xmlns:iwp="">

                        <Assembly>Microsoft.SharePoint, Version=, Culture=neutral, PublicKeyToken=71e9bce111e9429c</Assembly>












When SharePoint is deploying the page, it combines your .aspx page with what is in the elements.xml file to output the completed page.  At this point you are ready to install and activate your feature.  You can put this in a solution package at this point to ease deployment.  When you activate the feature, you should get something that looks like this.


Of course, deactivating the feature won’t remove this page or its web parts.  However, you can always easily implement a feature receiver to cleanup the files you deployed.  This is how you deploy simple pages using CAML.  This is effectively the same way that Site Templates deploy pages as well (except the web parts and views are defined in onet.xml instead).


# re: How to: Deploy a Page using a Feature

Friday, May 7, 2010 3:10 AM by anand

Hi Roth,

This is nice article, I have requirement where I need to create custom edit form sharepoint list(ex: Tasks list),

how I can achieve this functionality(I cann't use sharepoint designer) apart from designer is there any approach, please let me know.



# re: How to: Deploy a Page using a Feature

Wednesday, October 6, 2010 2:46 AM by Swati

Hi Roth,

This is a really helpful article.  I do have a small question though.  I am a little stuck at the URL section for Module in ProvisionedFiles.xml.  I have to deploy the page to the /Pages/Forms directory in sharepoint.  I am using the below URL - <Module Name="Pages" Url="$Resources:cmscore,List_Pages_UrlName;" Path="Pages" RootWebOnly="False">

This can deploy the page to the pages directory.  Can you tell me how to deploy to the Pages/Forms directory.  

# re: How to: Deploy a Page using a Feature

Wednesday, October 6, 2010 8:48 AM by CoreyRoth

On your Url attribute just change it to Pages/Forms and it will deploy to that folder.

# re: How to: Deploy a Page using a Feature

Friday, February 25, 2011 6:01 AM by CoxIanUK

Excellent article. Making full use of this for re-deploying an existing site into sharepoint.

My problem is I also want to set meta data for the pages (additional fields in the document definition). I have created <Data> section in the list defition that creates the new library but the information contained is not populated? The pages are available however and are listed

# re: How to: Deploy a Page using a Feature

Friday, February 25, 2011 8:51 AM by CoreyRoth

@CoxianUK Do you by chance happen to be using SharePoint 2010?  If so you can try using the PropertyBag element to set the properties you need.

# links for 2011-04-29

Friday, April 29, 2011 7:01 AM by HB's Thinking Usable

How to: Deploy a Page using a Feature - Corey Roth [MVP] (tags: sharepoint develop article tips 2011 2011.04) SharePoint Content Deployment Wizard (tags: sharepoint develop tools 2011 2011.04)...

# re: How to: Deploy a Page using a Feature

Wednesday, November 2, 2011 6:10 AM by ramesh

How do i deploy pages into sub sites' page library

# re: How to: Deploy a Page using a Feature

Monday, November 7, 2011 8:45 PM by CoreyRoth

@Ramesh just activate the feature on the subsite instead of the root site.

# re: How to: Deploy a Page using a Feature

Monday, November 14, 2011 8:12 AM by Ragu

You saved my day - thanks :- )

# re: How to: Deploy a Page using a Feature

Friday, March 16, 2012 6:29 PM by Vito

i have a permission problem.

i have follow your steps, it's all ok with an administrator account, but if i use an reader account i don't see the webpart in the webpartzone.

the webpartzone has the permession properties ?

# Technical Tuesday - How to: Use the Silverlight web part with Visual Studio 11 - Grid User Post

Tuesday, March 20, 2012 1:04 PM by The Grid Blog

Audience : Office 365 for professionals and small businesses Office 365 for enterprises

# re: How to: Deploy a Page using a Feature

Monday, April 2, 2012 10:54 PM by CoreyRoth

Check and see if the page is not checked in for some reason.

# Visual Studio 11 で Silverlight Web パーツを使用する方法

Saturday, April 7, 2012 7:16 PM by Office 365 の技術系ブログ

対象: Office 365 for Professional and Small Business , Office 365 for Enterprise 「Grid User Post

# re: How to: Deploy a Page using a Feature

Wednesday, May 16, 2012 3:29 PM by Sheela


I need to deploy site pages from visual studio for the initial release.

I have deployed custom master page and page layouts for the site. I need to apply them to the site page and deploy it from visual studio. Can you please help me with it?

# re: How to: Deploy a Page using a Feature

Tuesday, May 29, 2012 9:59 PM by CoreyRoth

@Sheela I'll need more details I am afraid.

# re: How to: Deploy a Page using a Feature

Monday, July 16, 2012 4:52 AM by Le Dang

Thank you for your notes. It is very useful.

# re: How to: Deploy a Page using a Feature

Wednesday, November 21, 2012 11:02 AM by Roby


on my site myservr/.../default.aspx

when I try to activate the feature..I've got this error

"Failed to instantiate file "default.aspx" from module "Page": Source path "default.aspx" not found. "

can you help me??


# re: How to: Deploy a Page using a Feature

Wednesday, November 21, 2012 11:04 AM by Roby

Sorry....the real error is

Failed to instantiate file "default.aspx" from module "Pages": Source path "default.aspx" not found.

# re: How to: Deploy a Page using a Feature

Monday, December 10, 2012 10:22 PM by CoreyRoth

@Roby double check the path to the URL of your file within the solution package.  Chances are it is wrong.

# re: How to: Deploy a Page using a Feature

Saturday, September 10, 2016 2:36 AM by Suriya

How to deploy the pages in subsite pages folder?

Leave a Comment