Sitecore: How to use sublayout parameters from codebehind?

6
votes

How do I get the values from the "Parameters" field (second screenshot) in the code-behind of the sublayout?

I understand I can get/set parameters on a rendering (specifically sublayout) when it is added to the presentation details of an item, just as described here (Sitecore 6 - using parameters).

layout instance parameters

However I would like to use the parameters field from the layout definition item. In the codebehind of the file belonging to to layout definition I can cast the parent to a sublayout and that object also has a .Parameters property, however this doesn't contain the values I'd expect.

layout definition parameters

This is the Page_Load method in the control code-behind:

protected void Page_Load(object sender, EventArgs e)
{
    var sublayout = ((Sublayout)this.Parent);
    string rawParameters = Attributes["sc_parameters"];
    NameValueCollection parameters =
      Sitecore.Web.WebUtil.ParseUrlParameters(rawParameters); 
      //parameters contains values from "Additional parameters (first screenshot)

      //I do not know the sublayout item id or sublayout path, so how do I get
      //the values from the second screenshot?
}

Doublecheck still doesn't work, only additional parameters are shown:

Step 1 - Enter parameters

Step 2 - Add sublayout + parameters to presentation

Step 3 - Display parameters on sublayout

Step 4 - Validate result

2
layoutparameterssitecoresitecore6
What are you really trying to do here? I don't understand the point of accessing this field since it will be static across all the items which use the rendering. You might as well hard-code the value in your sublayout .ascx, or an AppSetting value... Or if you need to get at it in Content Editor, then in the Standard Values of presentation details for your item template. - Bryan
Hardcoding the data might be a solution. I'm using the sublayouts as a container for another file and need to specify this filepath and some more data. - ReFocus
Just to be clear. You want to get the Parameters from the SublayoutItem and not from the Sublayout definition set in the layout details field of an item. Is that right? - marto
@marto: Actually I want both... - ReFocus

2 Answers

12
votes

Like this:

var sublayout = ((Sublayout)this.Parent);
NameValueCollection nvc = Sitecore.Web.WebUtil.ParseUrlParameters(sublayout.Parameters);

Here's a blog post that make it easier to do with extension methods.

Here's a shared source module for Sitecore that wraps this up in a class as well. It was written by John West, CTO of Sitecore USA.

2
votes

You can get the parameters defined on the sublayout but it's a bit long winded. You need to find the correct rendering item first and from there retrieve the parameters

   var sublayout = ((Sublayout)this.Parent);
   //Get all rendering
   var renderings = Sitecore.Context.Item.Visualization.GetRenderings(Sitecore.Context.Device, true);

   //Get the first rendering that matches the current sublayout's path
   var sublayoutRendering = renderings.FirstOrDefault(r => r.RenderingItem.InnerItem["Path"] == sublayout.Path);

   if (sublayoutRendering != null)
         Response.Write(sublayoutRendering.RenderingItem.Parameters);

You can use Mark's way to get the parameters for the parameters set in the "Layout Details"

EDIT: The above solution will work but it's very fragile and depends on sitecore internals that might change in the future. I wouldn't recommend you go with it in production with it. There must be a better way to achieve what you want.