Sitecore Sublayout Parameter Templates

I found out that many Sitecore Developers never used Sublayout Parameter Templates, so I decided to make a post about them.

Imagine that you have a situation in which you need to pass items from different datasources to a single stand alone sublayout. You obviously cannot use the Sublayout Datasource parameter and the content editors (especially new ones) might find the whole concept of adding Item IDs to the additional parameters a bit confusing. In such situations the Sublayout Parameter Templates come in handy.

Here are the simple steps that you need to execute in order to leverage the Sublayout Parameter Templates.

Step 1 – Creating a new template

Create a new template that uses “/System/Layout/Rendering Parameters/Standard Rendering Parameters” as a base template.

My First Rendering Parameters Template

Step 2 – Creating the template fields

Create the template fields the same way you will do with any normal template. By using Standard Rendering Parameters as a base you won`t lose any of the Standard Template behavior your are used to.

My First Rendering Parameters Template Fields

 

Step 3 – Attaching the new template to the sublayout

Attach your new template by using the “Parameters Template” field on your Sublayout.

Attaching to a sublayout

Step 4 – Try if it works and add some data!

To add some data you just need to add the Sublayout to the presentation details and edit its settings.

My First Rendering Parameters Template Datasource

Step 5 –  Handle it in code!


Sublayout sublayout = Parent as Sublayout;
NameValueCollection sublayoutParameters = Sitecore.Web.WebUtil.ParseUrlParameters(sublayout.Parameters);

string title = sublayoutParameters["My Component Title"];
Item firstDatasource = Sitecore.Context.Database.GetItem(Sitecore.Data.ID.Parse(sublayoutParameters["My First Datasource"]));

And you are all set !

When dealing with Sublayout Parameter Templates (or Sitecore in General) – please consider using ORMs like Glass Mapper to ease your work.

1 thought on “Sitecore Sublayout Parameter Templates”

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s