User Control & Dynamic Loading functionality

User controls allow you to save a part of an existing ASP.NET page and reuse it in many other ASP.NET pages.

Hence common functionalities (Headers, Footers, Menus, Dashboards…) are developed as user controls and used in Project.

The following line includes a header user control from the HeaderUserControl.ascx file:

<%@ Register TagPrefix=”uc1″ TagName=”HeaderUserControl” Src=”HeaderUserControl.ascx” %>

The header is then positioned on the page using the following tag:

<uc1:HeaderUserControlid=”Header1″runat=”server”></uc1:HeaderUserControl>

Although this procedure is satisfactory for content like headers and footers that will always be required on specific pages, it would be useful if there was a way of dynamically loading specific user controls at run time.

Fortunately, it is possible to load user controls onto a page by making use of the LoadControl method.

This function has a straightforward syntax – it takes a single argument – the virtual path to the user control page. For example, to load the featured product user control the following C# code would be used within the Page_Load method:

Control FeaturedProductUserControl = LoadControl(“FeaturedProduct.ascx”);

Once the user control has been loaded, it can be added to the page by adding it to the Controls collection:

Controls.Add(FeaturedProductUserControl);

The drawback with this technique is that it offers no control over where on the page the user control will actually appear. A useful tip is, therefore, to add a place holder control to the page in the position that you want it to display the dynamically loaded user controls. A place holder does just that – it acts as a container for other controls. You can then specify that the user control appear within the place holder by adding the user control to the place holder’s controls collection:

PlaceHolderLeftMenu.Controls.Add(FeaturedProductUserControl);

Alternatively it is possible to position the user control in other ways, such as adding it to a Panel control:

PanelRightMenu.Controls.Add(FeaturedProductUserControl);

Making Full Use of Dynamically Loaded User Controls

Since it is possible to dynamically load user controls onto specific pages, it provides the idea functionality for creating page templating facilities within ASP.NET. For example, by storing the details of available user controls in a database, it would be possible to write a content management system that allowed the website’s administrative users to choose which user controls they wanted to display on each page. This page templating system is used in content management systems such as the portal layout functionality in Microsoft’s SharePoint Portal Server.