Derek Hunziker
Derek Hunziker

Reputation: 13141

How to get content of rendering programmatically?

I am attempting to write a method that will output the content (i.e. HTML) for any renderings that happen to exist within a specific placeholder. The goal is to pass in a Sitecore.Data.Items.Item and the placeholder key that i'm interested in, and the method should return the rendered content.

The issue with this seems to be that there is no page context established, and therefore calling RenderControl() is throwing a null reference error in the GetCacheKey() method of the Sublayout.

Is anyone aware of a way to render a Sublayout or XSLT rendering programmatically?

Here's what I've got so far:

private string GetPlaceholderContent(Item item, string placeHolder)
{
    StringWriter sw = new StringWriter();
    using (HtmlTextWriter writer = new HtmlTextWriter(sw))
    {
        foreach (RenderingReference renderingReference in item.Visualization.GetRenderings(Sitecore.Context.Device, false))
        {
            if (renderingReference.Placeholder == placeHolder)
            {
                // This ensures we're only dealing with Sublayouts
                if (renderingReference.RenderingItem.InnerItem.IsOfType(Sitecore.TemplateIDs.Sublayout))
                {
                    var control = renderingReference.GetControl();
                    control.RenderControl(writer); // Throws null reference error in GetCacheKey()
                }
            }
        }
    }

    return sw.ToString();
}

Upvotes: 12

Views: 6191

Answers (2)

Nikolay Mitikov
Nikolay Mitikov

Reputation: 533

It is almost 8 years since the question was originally asked, and it turn to be Uniform - rendering any item/placeholder fragment!

Yes, it cuts the item you supply into placeholders/renderings:

enter image description here

The next step is to produce markup (for every possible data source out there):

enter image description here

That content is published into CDN and browser picks which version to load = personalization works!

In other words, the question you've asked turned into a cutting-edge product that can do so much more on top of that!

You could reverse-engineer the Uniform assemblies to see how they actually do that ;)

Upvotes: 1

Zachary Kniebel
Zachary Kniebel

Reputation: 4794

In my opinion, the best way to programmatically render a Sublayout is to use a repeater, and put a <sc:Sublayout> tag in the <ItemTemplate>.

From there you only have to do one or both of the following:

  1. Set the DataSource property of the <sc:Sublayout> to be the string representation of the desired item's GUID (i.e. the data source for the sublayout, if any)

  2. Set the Path property of the <sc:Sublayout> to be the path to the Sublayout that you wish to render.

The server/sitecore will handle the rest.

Upvotes: 0

Related Questions