如何在Web.config中注册用户控件和自定义控件

如何在Web.config中注册用户控件和自定义控件

【原文地址】 Tip/Trick: How to Register User Controls and Custom Controls in Web.config
【原文发表日期】 Sunday, November 26, 2006 12:57 PM

去年我一直把这个技巧包含在我的ASP.NET 技巧/诀窍讲座里，但倘若有这么多人总是为它的存在而感到惊讶的话，我想值得用一个专属的技巧/诀窍帖子来提高它的可见度 (点击这里阅读我的ASP.NET 技巧/诀窍系列里的其他帖子)。

问题：

在ASP.NET 的早先版本里，开发人员通过在页面的顶部添加 <%@ Register %> 指令来引入和使用自定义服务器控件和用户控件时，象这样：

 

<%@ 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 >

 

注意到上面的前两个注册指令是用来注册用户控件的(是在.ascx文件里实现的)，最后这个是用来注册编译进一个程序集 .dll 文件里的自定义控件的。注册完后，开发人员可以在页面的任何地方用设定好的 tagprefix (标识前缀)和标识符号名( tagname)来声明这些控件。

这行之有效，但管理起来会很痛苦，当你要在你的网站的许多页面上使用控件的话，尤其是，假如你移动了.ascx 文件，需要更新所有的注册声明的话。

解决方案：

ASP.NET 2.0 使得控件声明极其干净而且管理起来极其容易。不用在你的页面上重复这些声明，只要在你的应用的web.config 文件的新的 pages->controls 部分声明一次即可：

 

< ?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 >

 

你可以用这种方式同时声明用户控件和编译好的自定义控件。当你使用这个技巧时，Visual Studio是完全支持这两者的，而且 VS 2005 Web Site 项目 和 VS 2005 Web Application 项目也都支持这两者。Visual Studio会在设计器里以所见即所得(WYSIWYG)模式显示这些控件，也会在后台编码文件里提示控件字段的声明。

需要注意的是，上面用户控件中“~”句法的使用。对那些不熟悉这个符号的人，ASP.NET中“~”符号意思是“从应用的根路径来定位”，它提供了一个很好的方法来避免在你的编码里到处使用“../”。在web.config文件里声明用户控件时，你总是应该使用它，因为页面也许会使用在不同子目录里的控件，所以你应该总是始终如一地从应用的根路径开始定位这些控件。

一旦你在web.config 文件中声明好这些控件后，你就可以在你网站上的任何一个页面，母板页或者用户控件中使用它们了，象这样(不再需要注册指令)：

 

 

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

希望本文对你有所帮助，

Scott

附注：特别感谢 Phil Haack ，他在这个月的早先时候也曾在博客里讨论过这个技巧。对你们中间那些不认识 Phil 的人，他帮忙建造了非常受欢迎的 SubText博客引擎，而且拥有一个非常精彩的博客。

标签： ASP.NET, Visual Studio, .NET, Tips and Tricks