Skip to main content

Server Controls, UniqueID and Master pages

Recently I was updating some ASP.NET pages for a client. They had a set of custom-built server controls that worked very happily, binding data to and from domain objects. I modified some of the ASP.NET pages so that they became Content pages that shared a common Master page. Then suddenly all the Server controls stopped working - they were not processing postbacks properly or firing events. That is, Server Controls that had worked in normal ASP.NET pages suddenly stopped working in Master-Content pages.

Eventually I tracked the problem down to the overridden Render method in the Server Controls, and the id that was rendered to HTML. If you Render your Server Controls like this:

protected override void Render(HtmlTextWriter output)
{
// . . .
output.AddAttribute("id", this.ID);
output.AddAttribute("name", this.ID);
output.RenderBeginTag("input");
output.RenderEndTag();
// . . .
}

... and the control also implements IPostBackDataHandler (with the LoadPostData method and so on), the control will work as long as it is not inside a composite control or a control container.

However, if you put the control inside a control container (such as a ContentPlaceHolder in a Master-Content page), ASP.NET will no longer be able to figure out how to map the Form data that gets posted to the server back to the control. Hence LoadPostData (and RaisePostDataChangedEvent) will not get called.

This bug is easily fixed - the html ID and Name of your control should be rendered using UniqueID, as follows:

protected override void Render(HtmlTextWriter output)
{
// . . .
output.AddAttribute("id", this.UniqueID);
output.AddAttribute("name", this.UniqueID);
output.RenderBeginTag("input");
output.RenderEndTag();
// . . .
}

(In fact, "id" might not be needed at all, but is useful. "name" is the one that maps Form data on postback)

Of course, most documentation stresses that Server Controls should render using UniqueID if they want to catch postback data (Here's the MSDN documentation on Capturing Postback Events in Server Controls). But this might catch people out, because if you use ID instead of UniqueID, your control might happily work for years until you put it into a control container.

See also: MSDN - Developing Custom Controls: Key Concepts

Comments

Popular posts from this blog

Copying data to Salesforce Sandboxes using TalenD

A common problem with Salesforce Developer Sandboxes is that they are blank. Really you're going to want some data in there, so there are various strategies for copying data from your live instance to the Sandbox. There are some paid-for solutions - SFXOrgData , Salesforce Partial Data Sandboxes - but if you've got a decent ETL tool you can build your own. There are a bunch of free ETL tools for Salesforce: JitterBit Data Loader is good for quick ad-hoc tasks but the free version makes it difficult to manage specific ETL projects or share projects with other users Pentaho Community Edition - an open source edition of the enterprise version Apatar was a free open source Salesforce ETL which still works but development seems to have stopped since 2011 TalenD Open Studio is an open source ETL tool For the task of copying data from live to a Sandbox, either Pentaho or TalenD Open Studio could be used, depending on preference. Here's a good comparison of the dif

SSRS multi-value parameters with less fail

SSRS supports multi-value parameters, which is nice, but there are a few issues with them. This is how I deal with them. Two of the problems with SSRS multi-value parameters are: You have to jump through a few hoops to get them to work with stored procedures The (Select All) option, as shown above The reason the (Select All) option is a problem is that it is a really inelegant way of saying 'this parameter does not matter to me'. If you have a list with hundreds of values, passing all of them as a default option just seems wrong. Also, if your report shows the user which items they selected, printing the whole list when they choose (Select All) is excessive. So in this post I'm going to show my particular way of: Jumping through the hoops to get Multi-Value params in a stored procedure Adding a single '--All--' value that the report interprets as meaning all the options. Getting Multi-Value params to work with Stored Procedures This is

Remote Desktop on High DPI screens

Scott Hanselman wrote a nice blog post back in January about some of the issues you might face running Windows on a High DPI screen like that of a Surface Pro or Lenova Yoga. I'm kindof mystified that he didn't mention Remote Desktop though because thats been the number one problem for me on High DPI screens. That said, if you remote into very recent Server OS's like Windows Server 2012 R2, then apparently Remote Desktop will sort out the DPI scaling automatically. Perhaps Scott hadn't noticed the Remote Desktop issue because he only remotes into Server 2012 R2. Certainly if I was Scott, I wouldn't remote into anything less than that. But, in practice, I regularly have to remote into Server 2008 machines and yes even Server 2003. If you do that from a high DPI screen, the remote desktop is rendered at regular pixel size, which makes everything tiny. Its hard to show screenshots of High DPI screens that correctly convey the pixel size, so I've photoshoppe