Skip Ribbon Commands
Skip to main content

Dynamic Page Layouts in SharePoint 2013 - Part 2

Persisting Page Configuration

James Strugnell

05/09/2016

​This is another article in our series explaining how we built a Dynamic Page Layout system in SharePoint 2013. For an introduction please read here​. In this post I'm going to cover how we persist the page level configuration for our Dynamic Page Template. i.e. how each row in our Dynamic Page is configured, and ordered. 

To recap, each row is configurable to use a specific template (i.e. Full Width, 2 columns, 3 columns etc.). In addition to the template used, we also need to store where on the page the row should go (a positional index), if it should have a background colour, top/bottom margin and top/bottom padding and any other required Row-level configuration options. So we needed a place and method to store this configuration as part of every dynamic page. 

Our plan was to use a JSON object for the data and then store it somewhere within each page, as part of that page. We could then enable an editor interface, within the page, that would allow content editors to add, edit and delete rows as needed. Thus when they save the page, they will save the configuration data along with it. We would then be able to read this configuration out on page load, loop over it, and render the required Templates (which are essentially User Controls) and then run some code over each row template to initialise the child Web Part Zones with unique IDs (a problem covered in a later post).

That was the concept, how could we do it.

Where and How to Store the JSON Configuration

Firstly, how could we store the JSON object within the page. My first thought was that we could leverage the Property Bag for the page. If you aren't aware of the Property Bag it is a SharePoint concept where almost every type of object (container) in SharePoint (Farm, Web App, Site collection, Site, List, Item etc.) has an associated "Property Bag" which is a Key/Value pair storage area. It is normally ideal for configuration data, however I had a better idea for this scenario.

Given that we are working with Publishing Pages, we have access to "Fields" within each page. For the project we were working on we had access to a "Base Page" Content Type from which every Publishing Page type inherited. So I added a new field called DynamicPageConfiguration to the Base Page Content Type. This was a multiline text field of type "Note", configured to use 20 rows. As the field was always likely to exceed 255 characters we also had to set the property "UnlimitedLengthInDocumentLibrary" to "TRUE".

So we now had a field available to us on every page in which we could store text (JSON) data. I added this field to the Dynamic Page Template and it showed up on the page as an editable textbox field. You can see in the following code how we wrapp it in an EditModePanel so that it only rendered in the page while in "Edit" mode (funny that). We also set it to be hidden using CSS so that it wasn't actually visible on the page. We didn't want Content Managers to edit the field directly, we would build an interface that then read and wrote to this field in the background.

The beauty of this approach was that SharePoint would save the data in this field for us, without us having to anything. It was just a field on the page. You might notice that the field has an additional CSS Class of "js-DynamicPageConfiguration". This is the selector used from JavaScript when a user edits the page configuration through a popup form. I will go into more detail on that process in my next post.

To help understand the configuration data being stored on each page, here is an example of the JSON stored in this field, as viewed using the ever useful online JSON Viewer tool:

Dynamic Page Config JSON.png

Hopefully the concepts are coming together for you now, and perhaps even making sense (?). Later in this series you will see how we added a control on the Dynamic Page template that iterates over the JSON configuration data above and loads the associated User Controls to render the required columns. Content Managers then interact with this page in edit mode, adding and editing rows of Web Part Zones, and then adding Web Parts into those zones. Here's a sneak preview of how that looks. In the screen grab below I've just clicked to edit an existing Row (using the Cog icon in the top-right of each row). You can also see the option to "Add new dynamic row" along the bottom, which initiates the same form.

Dynamic Page Row Form.png

We'll cover how the above form works in the next post. Until then, thanks for reading.



 About us

Fuse Collaboration Services is a Cloud Solution Provider and Microsoft Gold Partner specialising in delivering SharePoint, Skype for Business, and Azure cloud-based solutions. Based in Northampton, UK.

Microsoft Gold Partner Logo showing 5 competencies

Read more

 Latest Tweets

 Latest Blog

 

 

SharePoint - The Production Hub of Every Efficient Modern Office923<p class="lead">Monty Python's quest for the holy grail took King Arthur up hill and down dale, through woods and across rivers, and past challenges a-plenty.</p><p class="lead">Every business has its own quest for as high a level of productivity as possible, and fortunately you don't have to overcome the Black Knight to reach your ultimate goal.</p><p>But it is a journey worth taking, as according to some research undertaken by Nucleus Research in 2016 nearly 5 percent of GDP in the United States was lost in productivity costs as employees searched for content within their company's systems, with a further 3.6 percent of GDP spent on re-creating content that had already been lost.</p><p>For a company that turns over £10 million per annum this is equivalent to £460,000 of needless productivity costs simply searching through archives and £360,000 of content re-creation costs.</p><p>This has been recognised by some of the world's most outstanding businesses, with 85 percent of Fortune 500 companies already using SharePoint, Microsoft's collaboration software, to underpin their continued success.</p><p>But you don't have to have turnover in the billions of pounds to reap the benefits of a relatively small investment in SharePoint.</p><p>SharePoint gives you a clear and concise entry point both into your archives and current content, and allows you to share and work on many types of documents within your working groups in real time. No waiting for one person to finish editing before you make amendments, no laborious wading through folders upon folders of content from times past, just simple and easy processes wherever you are in the world and whatever device you are using.</p><p>SharePoint is an integral part of our operations here at Fuse, which means that we know just how to make the most of its impressive capabilities. We also know that there is no such thing as an 'off the shelf' solution to any organisation, and we take the time to work with you to find out exactly what you want and how we can help you achieve it.</p><p>Proactive businesses are successful businesses, so get ahead of the curve with <a href="/_layouts/15/FIXUPREDIRECT.ASPX?WebId=4fc45909-2b6d-48b9-bcf9-a446e9d472d6&amp;TermSetId=c98895cd-d37f-4406-9cff-5480b4f829b6&amp;TermId=5abcf6c4-2a4a-45fa-af70-4468462b3732">SharePoint​​</a>.</p><hr /><div class="well"><p> <strong>Jargon busting</strong><br><em>SharePoint</em>&#58; Microsoft's collaboration software that lets your working groups share documents, information, news and apps in a secure and easily accessible place. SharePoint is available both as a stand-alone product and as part of Office 365, and is the hub of any successful modern office</p><p> <strong>How it works</strong><br>SQL databases (configuration, services and content) deliver content to web clients through both a web browser as well as tightly-integrated Office applications and the Windows operating system</p><p>The base platform provides authentication, workflow, content, search and data processing services</p><p>APIs and service end points allow the platform to be extended through development, while the interface look-and-feel can be customised through common web development tools.​</p></div>​ | Chris Wearmouth | 693A30232E777C6675736563735C632E776561726D6F757468 i:0#.w|fusecs\c.wearmouth04/04/2018 23:00:002018-04-04T23:00:00ZSharePoint reduces time spent searching for and duplicating content24/04/2018 02:36:241286htmlFalseaspx

 Contact us

Our address
12 Brookfield, Duncan Close
Moulton Park, Northampton
NN3 6WL
P: +44(0)1604 797979
Contact Us