Tip/Trick: How to Register User Controls and Custom Controls in Web.config

I've been including this technique in my ASP.NET Tips/Tricks talks the last year, but given how many people are always surprised by its existence I thought it was worth a dedicated tip/trick post to raise the visibility of it (click here to read other posts in my ASP.NET Tips/Tricks series).

Problem:

In previous versions of ASP.NET developers imported and used both custom server controls and user controls on a page by adding <%@ Register %> directives to the top of pages like so:

<%@ Register TagPrefix="scott" TagName="header" Src="Controls/Header.ascx" %>
<%@ Register TagPrefix="scott" TagName="footer" Src="Controls/Footer.ascx" %>
<%@ Register TagPrefix="ControlVendor" Assembly="ControlVendor" %>

<html>
<body>
    
<form id="form1" runat="server">
        
<scott:header ID="MyHeader" runat="server" />
    </
form>
</body>
</html>

Note that the first two register directives above are for user-controls (implemented in .ascx files), while the last is for a custom control compiled into an assembly .dll file.  Once registered developers could then declare these controls anywhere on the page using the tagprefix and tagnames configured.

This works fine, but can be a pain to manage when you want to have controls used across lots of pages within your site (especially if you ever move your .ascx files and need to update all of the registration declarations.

Solution:

ASP.NET 2.0 makes control declarations much cleaner and easier to manage. Instead of duplicating them on all your pages, just declare them once within the new pages->controls section with the web.config file of your application:

<?xml version="1.0"?>

<configuration>

  
<system.web>
    
    
<pages>
      
<controls>
        
<add tagPrefix="scottgu" src="~/Controls/Header.ascx" tagName="header"/>
        <
add tagPrefix="scottgu" src="~/Controls/Footer.ascx" tagName="footer"/>
        <
add tagPrefix="ControlVendor" assembly="ControlVendorAssembly"/>
      </
controls>
    
</pages>

  
</system.web>

</configuration>

You can declare both user controls and compiled custom controls this way.  Both are fully supported by Visual Studio when you use this technique -- and both VS 2005 Web Site Projects and VS 2005 Web Application Projects support them (and show the controls in WYSIWYG mode in the designer as well as for field declarations in code-behind files).

One thing to note above is the use of the "~" syntax with the user-controls.  For those of you not familiar with this notation, the "~" keyword in ASP.NET means "resolve from the application root path", and provides a good way to avoid adding "..\" syntax all over your code.  You will always want/need to use it when declaring user controls within web.config files since pages might be using the controls in different sub-directories - and so you always need to resolve paths from the application root to find the controls consistently.

Once you register the controls within the web.config file, you can then just use the controls on any page, master-page or user control on your site like so (no registration directives required):

<html>
<body>
    
<form id="form1" runat="server">
        
<scott:header ID="MyHeader" runat="server" />
    </
form>
</body>
</html>

Hope this helps,

Scott

P.S. Special thanks to Phil Haack who blogged about this technique as well earlier this month (for those of you who don't know Phil, he helps build the very popular SubText blog engine and has a great blog).

Published Sunday, November 26, 2006 12:57 PM by ScottGu

Comments

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 5:03 PM by John West

Question: I've been using this sparingly... I'm worried that it might impace performance.  Do you think so?  In other words, if I register 30 user controls and 5 custom server controls in this way, will my pages slow down?  Will compilation slow down?

Thanks!

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 5:15 PM by Haacked

Thanks for the shot out Scott!  Much appreciated, especially from such a great blog and blogger. Yep, I'm a ScottGu fanboy. ;)

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 6:08 PM by ScottGu

Hi John,

The good news is that there isn't any performance difference between registering them in a web.config file vs. at the top of a page.  

The runtime performance is exactly the same (they get compiled down to the same instructions in both scenarios).

Compilation should also compile at the same performance.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 6:28 PM by Chris adf471587879rzq

Scott,

There's a mistake in your code.  In the "Solution" in which the registrations are placed in the web.config file, this line:

<scott:header ID="MyHeader" runat="server" />

should be ....

<scottgu:header ID="MyHeader" runat="server" />

because you used a different tag prefix ("scottgu") in the revised version.

Thanks for the info!

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 6:30 PM by ScottGu

Hi Chris,

Good catch! ;-)

Hopefully you got the point anyway! :-)

Thanks,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 11:26 PM by ScottGu

Hi Adam,

There are cases when the designer can't infer the base class of a user-control with VS 2005 Web Application Projects - in which case it just generates a field declaration in the code-behind of the page as type "UserControl".

To get a strongly-typed declaration of the user-control, you can manually add the declaration to your code-behind class (not the .designer class) of the type you want (which is typically the UserControl code-behind class name).

Once you do this the designer will pick this up and use it as the field declaration and you'll get full intellisense.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Sunday, November 26, 2006 11:44 PM by vikram

good trick

I have been using this trick but for only those controls which are used through out the Site. I always thought if a user control is used only ate one or 2 place, It should be placed in the Page itself, but if used at many pages in the site then should be declared in the web.config file

Thanks

Vikram

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, November 27, 2006 7:03 AM by Ryan S

With regards to the user control being declared with the incorrect data type in the designer.cs file - does your solution (manually declare the variable in the code behind file) "force" the invalid declaration to be removed from the designer.cs file? Or will there be a duplicate named variable with a different data type?

I am using Web Application Projects and understand this to be a limitation of that project type currently.

Is this something that is going to be addressed in a service pack or hotfix to the web application project?

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, November 27, 2006 10:08 AM by ScottGu

Hi Ryan,

If you declare the control type/name in your code-behind file in a VS 2005 Web Application Project, then the designer automatically avoids adding it to the .designer.cs/.vb file.  

This avoids any duplicate name collisions (note: you'll need to flip once to source view or design view and make a change in order to have the designer remove it from the .designer file - from them on out it will be omitted).

The reason you sometimes need to-do this are in cases where the control is implemented inside the same assembly as the pages.  You can sometimes get into an un-buildable state where the designer can't reflect on the project to infer the type (this isn't a problem with controls implemented in other projects or separate assemblies - since they are already successfully compiled).  This situation is less of a "bug" per-se - and more of a design outcome of building everything within the same assembly.  We are going to continue to look for ways to make this case less common - but there will always be some times when you can't reflect and get the type details.  In cases like this you can just declare the field in your code-behind file and everything will work.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, November 27, 2006 2:50 PM by Arash

quite nice! i didn know it exits.

does this add any overhead to the pages that don't implement the controls?

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, November 27, 2006 3:48 PM by ScottGu

Hi Arash,

The good news is that there is no performance penality to using this trick.  It is just as efficient as without.

Thanks,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, November 27, 2006 3:49 PM by ScottGu

Hi Ryan,

I actually just chatted with someone on the VS 2005 Web Application Project feature team, and he actually mentioned that they've added some better detection support for this in SP1.  So you should actually see the cases where you need to declare a field in the code-behind to get a type-specific value go down.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, November 29, 2006 3:42 PM by ScottGu

Hi Adrian,

Correct - the collection settings within a web.config file will inherit down to sub-applications by default.

What you can do in your sub-applications is to use <remove/> instead or <clear/> - and just specify the setting you wish to remove.

That way you won't clear everything.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, November 29, 2006 9:29 PM by Dave Frank

Hey Scott,

I have a usercontrol that exists in my master page, and I access its properties with:

CType(Master, botwmaster).myusercontrol.Visible = False

(for example)

Doing this requires that I add a reference to the control from the page: <%@ Reference Control="~/controls/usercontrol.ascx" %>

My question is, how would I add that reference in the web.config so I don't have to do that in every page?  I'd love to eventually get all control declarations and references to exist in a centralized place (for those that exist on multiple pages)

More food for thought - it would be great if things declared in a master page would bubble down to your aspx page - the control is registered in the master page with @register already.  

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Friday, December 1, 2006 2:26 PM by BT

Thanks for all the information, Scott.

This approach seems cleaner to me than @Register'ing the same controls all over the place. So, I embarked on a 5-minute journey through my application to take the registrations out of the .ASPX pages and all into web.config.

I ran into a problem though on pages where I would instantiate one of my user controls in codebehind and add it to a table cell. I've got a UC story.ascx with a public storyId that renders the content for a story - simple enough. I use the following in codebehind on various pages to stick stories in table cells:

 story myStory;

 myStory = (story)LoadControl("userControls/story.ascx");

 myStory.storyId = 1234;

 cell.Controls.Add(myStory);

However when I moved all the UC registrations to web.config, I ran into "The type or namespace name 'story' could not be found" - can you tell me why or how else I can accomplish this? Thanks!

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Saturday, December 2, 2006 6:46 PM by ScottGu

Hi BT,

If you are dynamically loading and then type-casting the control with a VS 2005 Web Site Project, you can add a <%@ Reference %> element to the top of your page.  This will add an assembly reference for you automatically and allow you to reference it like above.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Saturday, December 2, 2006 7:39 PM by ScottGu

Hi Dave,

One option to avoid the <%@ Reference %> directive would be to use the VS 2005 Web Application Project.  This compiles the entire project into a single assembly, and so avoids hte need to explictly reference page/controls.

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Tuesday, December 5, 2006 7:43 AM by Anupam

Hi Scott,

how do i force a page to load my usercontrol 's dll file form another path, instead of the /bin folder.

reasons for my wanting to do this.

1) i want to keep my control and its dll separate.

2)i don't want the website restarting each time the admin uploads a new usercontrol.

thnx.

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, December 6, 2006 4:53 AM by JP

Hi Scott,

This is very useful, but it brings some trouble along in my project: if I use a user control in another user control, and both controls are in the same directory in the project (in your example, ~/Controls/ ), this compile error occurs:

The page '/Controls/Outer.ascx' cannot use the user control '/Controls/Inner.ascx', because it is registered in web.config and lives in the same directory as the page.

I'd rather not move nested controls to a different directory. Is there a solution for this codewise, or will there be a fix in SP1?

Cheers

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, December 6, 2006 12:26 PM by Joe

Nice tip.

I changed my pages to use it.

One issue:

I have a user control which uses another user control. They both reside in a folder named \Controls.

I got this error:

The page '/MyApp/Controls/CtlA.ascx' cannot use the user control '/MyApp/Controls/CtlB.ascx, because it is registered in web.config and lives in the same directory as the page.

I just left it the old way.

BTW - that was a very good error message - it alowed me to pinpoint the problem right away.

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Thursday, December 7, 2006 9:47 AM by gbrock_isi

Scot - In a blog from Aug 28 2005 you discussed building a library of user controls and the ability to then consume them in other web applications. Twice in the blog it was asked how to reference the user control in the a page of the consuming application. For example, one entry said

Hi Scott. I am having a similar problem to a previous comment. This all works fine if I include the separate .ascx file. However, as soon as I set the build flag to not allow updating (which as a consequence does not create a separate .ascx file), I cannot get it to work. Your previous response was that ASP.NET can resolve the .ascx references at runtime. How do you register the control? without registering it, compilation fails. Thanks in advance Curtis.

I had been trying to do this for better part of two days and when I say the blog entry I thought, "Finally, I'll get the secret sauce". But your response was completely disappointing..

Hi Curtis,

What I'd recommend is for you to have the user-control project be marked as updatable, and copy the .ascx file into the consuming project.

You could then compile the consuming project as non-updatable.  This will then remove the HTML for both the pages on the site, as well as the user-control you are using.

Hope this helps,

Scott

How can one develop a distributable library of user controls and protect the source, as you claim is possible with the plethora of build options in VS2005, if you can't do this. I just want to know if it's possible or not and what one has to do?

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Friday, December 8, 2006 12:23 AM by ScottGu

Hi Greg,

Here is a blog post that discusses how to convert a user control into a compiled control: http://blogs.msdn.com/davidebb/archive/2005/10/30/487160.aspx

Thanks,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, December 13, 2006 10:05 AM by Brian Lowry

To those of you receiving this error: (JP)

The page '/Controls/Outer.ascx' cannot use the user control '/Controls/Inner.ascx', because it is registered in web.config and lives in the same directory as the page.

One solution I have read is to move the control out of the directory its currentyly sharing with outer.ascx, but this isn't feasible in my project.

I found that you can simply re-register the control inside of the outer.ascx:

<%@ Register TagPrefix="Brian" TagName="Inner" Src="Controls/Inner.ascx" %>

and the problem goes away.

# How about WebServices?

Monday, January 15, 2007 5:43 AM by Siderite

 How about Web Services? I have this Web User Control with a static method that uses LoadControl and executes some methods that use the controls inside the WUC. I am using it to render HTML which I then embed into an email. I want to do this inside a Web Service and nothing seems to be working. The error, of course, is that UcUserControl type is not valid in current context, but I can't add a register directive to the asmx, I can't use an assembly directive (I get ASP.NET runtime error: The file 'ucusercontrol.ascx.cs' cannot be processed because the code directory has not yet been built.) and declaring the user control in the web.config as in this article doesn't work.

Any idea how I can use inside a web service the type declared in the code behind of a web user control ?

Thanks.

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Friday, January 19, 2007 10:47 PM by ScottGu

Hi Siderite,

Have you seen this article of mine: http://weblogs.asp.net/scottgu/archive/2006/10/22/Tip_2F00_Trick_3A00_-Cool-UI-Templating-Technique-to-use-with-ASP.NET-AJAX-for-non_2D00_UpdatePanel-scenarios.aspx

It enables you to use .ascx templates within web-services to dynamically generate HTML.

Thanks,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Friday, February 2, 2007 1:19 AM by Siderite

 Thanks, Scott! It's a nice implementation, but it uses reflection. I was looking for an ASP.NET 1.1 like use of the web user control object in other objects, but I guess that's out of the question now.

 It was particularily interesting to see that your code to do the same thing as mine used a completely different method. You used LoadControl, I used Controls.Add (and had a lot of problems with it, of course) and then ServerExecute instead of RenderControl... Very useful stuff. Thanks!

# Problem in registering a user control in wb.config

Friday, February 23, 2007 5:59 AM by nishant

Hi

as u said that instead of registering a user control once per web page that v r going to use it within,its better to register it in web.config file

I did that and gave tagprefix,tagname and src attributes proper values.but the problem is

DO I NEED TO DRAG THE USER CONTROL ON MY WEB PAGE(S)

OR WUD I HAV TO MANUALLY WRITE THE TAGPREFIX AND TAGNAME ETC IN XYZ.ASPX PAGE TO SET THE VALUE OF ID ETC

IF I DO LATER WAY THEN THE VALUES OF TAGPREFIX AND TAGNAME I SPECIFIED ARE NOT PICKED UNDER XYZ.ASPX PAGE.(THEY ARE NOT SHOWN IN POP UP LIST)

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, February 26, 2007 8:39 PM by Richard

This works great but when I view the page(in Design mode) that contains the controls the controls show up in red. An error shows for each control that states: This control cannot be displayed because its TagPrefix is not registered in this Web Form. Also, the same error shows up in the Error List. The odd thing is that I can build the solution, run the project and view the page/controls perfectly. Is there anything that can be done to get rid of this annoying error message?

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Tuesday, February 27, 2007 2:13 AM by ScottGu

Hi Richard,

Can you try closing the project and re-open it to see if it makes any difference?

Are you opening things the same way in VS as they get invoked via IIS?  Meaning, is the web.config file in the root of the project?

Thanks,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Thursday, March 1, 2007 10:32 AM by Stephen Kinsey

Superb tip, works a treat and really helps to make the aspx pages look much neater.

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Friday, March 2, 2007 1:39 AM by Shekhar

Hi Scott !!!

thanks for sharing this useful information with us....

I also want to know how I can refers to User Control which resides in different directory than my project root directory

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Saturday, March 3, 2007 9:24 PM by ScottGu

Hi Shekhar,

You can do this by using the "~" syntax when referencing the controls from the root:

~/subdir/mycontrol.ascx

Hope this helps,

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Monday, March 5, 2007 1:22 AM by Shekhar

Hi Scott !!!

Thanks a lot for ur reply.....

The solution u have given works perfectly when controls are present in inner directory of root directory.

Wat about if the user controls are present in outside of root directory?

is it possible to refer that controls ?

Thanks again for your kind help

Shekhar

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Tuesday, March 6, 2007 10:25 PM by ScottGu

Hi Shekhar,

Unfortunately I don't think it is possible to register user controls outside of the application root directory.  

Sorry!

Scott

# re: Tip/Trick: How to Register User Controls and Custom Controls in Web.config

Wednesday, March 7, 2007 10:46 AM by Justin Wignall

Hi Scott,

I had previously used your tips above and added all of my usercontrols into the web.config file. Great! It's a really useful feature and it worked perfectly.

Now it doesn't. For some reason all of my code has stopped working and when trying to debug the build fails (along with intellisense etc.)

I was adding controls dynamically e.g.

Dim News As Controls_News = LoadControl("~/Controls/News.ascx")

Where Controls_News is the partial class name.

Adding a register directive to the page solves this issue, I am just wondering if you or any of your readers here would know why it worked for a while and then stopped?

I created a new project, cleaned ASP.NET temp files directory and so on and the problem persists.