Jun
12
2008

How to update properties of an already provisioned and in use page layout

Let's say you have a custom page layout and you want to give this page layout an unique Publishing Preview Image. To allow users to easily choose the right page layout among many different layouts.

This can be done easily if it is a NEW page layout. All you need to do is to define the PublishingPreviewImage element when you provisioning it.


<!-- PageLayout.xml -->



<Elements xmlns="http://schemas.microsoft.com/sharepoint/">

  <Module Name="PageLayouts" Url="_catalogs/masterpage" Path="PageLayouts" RootWebOnly="TRUE">



<File Url="CustomPageLayout.aspx" Type="GhostableInLibrary" IgnoreIfAlreadyExists="TRUE"  >

      <Property Name="Title" Value="My Custom Page Layout" />

      <!-- new added description -->

      <Property Name="MasterPageDescription" Value="This page layout is used for new sites." />

      <!-- new added preview image -->

      <Property Name="PublishingPreviewImage" Value="~SiteCollection/_layouts/images/pagelayouts/custompagelayout.gif" />

      <Property Name="ContentType" Value="Custom Content Type" />

      <Property Name="PublishingAssociatedContentType"

                Value=";#Custom Content Type;#0x010100C568D1D2D3D0A14D9B2FDCC96666E9F2007123456EC3DB064584E219954237AF123456;#"/>

</File>



</Module>



</Elements>
 

Problem -

What if you want to do this for the page layout which already in use and provisioned?  The challenging part is that when page layout has already been provisioned and used across webs. Any metadata changes made in page layout provision feature will NOT update its metadata in SharePoint site.

That means even if you changed PublishingPreviewImage element value. The preview images for the already in use page layouts in CreatePage.aspx will still use default image (DefaultPageLayout.png)

 

This screen shot shows the page layout is still using default preview image

James Tsai .Net SharePoint Blog - Page Layout Preview Image Default 

 

Solution -

Create a SPFeatureReceiver class and register it with same feature that provisions page layout(s) . In the FeatureActivated, update each page layout metadata base on the page layout manifest file.

Every time you want to update custom page layout property, just update manifest file, deactivate and re-activate this page layout provisioning feature.

This screen shot shows after reactivated the feature page layout is now using new preview image and new description.

James Tsai .Net SharePoint Blog - Page Layout Preview Image Default

Note: Although you can update each individual layout manually , you would expect the update should be done automatically every time you change layouts manifest and provision them again. That is the main reason to warp the logic inside feature receiver class to mimic the automation.

 

Please see below for code samples


<!-- Page layout provision feature schema -->


<Feature

  Id="23451A4D-3645-4531-B3A1-E25C6740D321"

          Title="Custom page layouts provisioning feature"

          Description="Provisions custom page layouts."

          Version="1.0.0.0"

          Scope="Site"

          Hidden="FALSE" DefaultResourceFile="core"           

          xmlns="http://schemas.microsoft.com/sharepoint/"

          ReceiverAssembly="James.Tsai.Net.SharePoint, Version=1.0.0.0, Culture=neutral, PublicKeyToken=12345bf123eec123"

          ReceiverClass="James.Tsai.Net.SharePoint.PageLayoutProvisioningFeature"          

          >

  <ElementManifests>

    <ElementManifest Location="PageLayouts.xml"/>

  </ElementManifests>

</Feature>

The feature receiver class will look like following code sample.

//Feature receiver class

class PageLayoutProvisioningFeature : SPFeatureReceiver
{
    public override void FeatureActivated(SPFeatureReceiverProperties properties)
    {
        using (SPSite site = (SPSite)properties.Feature.Parent)
        {
            //Load manifest file as XmlDocument.
            XmlDocument manifestXml = LoadPageLayoutsManifestAsXml(properties);

            //Load all page layouts for the site into dictionary
            Dictionary<string, PageLayout> allLayouts = LoadSitePageLayouts(site);

            //Now we have an entire page layouts manifest as XmlDocument.
            //We also have a collection of all page layouts
            //We can now step through each page layout defined in manifest and check every propertie
            //against layouts in allLayouts Dictionary.

            //Update layout property in allLayouts Dictionary with value defined in manifest file

            //Check out page layout
            //Call pagelayoutsDic[pagelayoutName].Update()
            //Check in page layout
        }       
    }

    //LoadPageLayoutsManifestAsXml(){} ... see next section

    //LoadSitePageLayouts(){} .... see next section
}

LoadPageLayoutsManifestAsXml method

private XmlDocument LoadPageLayoutsManifestAsXml(SPFeatureReceiverProperties properties)
    {
        //Get feature definition as xml node
        XmlNode def = properties.Definition.GetXmlDefinition(System.Globalization.CultureInfo.CurrentCulture);
        //Create xml namespace manager
        string wss = "wss:";
        string xpath = wss + "ElementManifests/" + wss + "ElementManifest";
        XmlNameTable nameTable = new NameTable();
        XmlNamespaceManager manager = new XmlNamespaceManager(nameTable);
        manager.AddNamespace("wss", "http://schemas.microsoft.com/sharepoint/");
        //Create an enumerator and get ElementManifest node
        IEnumerator enumerator = def.SelectNodes(xpath, manager).GetEnumerator();
        XmlNode current = (XmlNode)enumerator.Current;

        //Get manifest file name PageLayouts.xml from ElementManifest node
        string PageLayoutsManifestFileName = current.Attributes["Location"].Value;

        //Load manifest file to XmlDocument object
        XmlDocument doc = new XmlDocument();
        doc.Load(feature.Definition.RootDirectory + "/" + PageLayoutsManifestFileName);

        return doc;
    }

 

LoadSitePageLayouts method

private Dictionary<string, PageLayout> LoadSitePageLayouts(SPSite site)
    {
        PublishingSite publishingSite = new PublishingSite(site);               
        PageLayoutCollection pageCollection = publishingSite.PageLayouts;
        Dictionary<string, PageLayout> pagelayoutsDic = new Dictionary<string, PageLayout>();
        foreach (PageLayout layout in pageCollection)
        {
            pagelayoutsDic.Add(layout.Name, layout);
        }              

        site.Dispose();       

        return pagelayoutsDic;
    }

blog comments powered by Disqus