Scott Guthrie 博客中文版

Scott Guthrie's Blog on ASP.NET and .NET (英文原版地址:http://weblogs.asp.net/scottgu)

   博客堂 :: 首页 :: 联系 :: RSS 2.0 ::
随笔 - 204, 评论 - 1023, 引用 - 436

导航

标签

每月存档

最新留言

广告

 

【原文地址】 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博客引擎,而且拥有一个非常精彩的博客。

打印 | 张贴于 2006-11-27 09:20:00 | Tag:ASP.NET  .NET  Visual Studio  Tips and Tricks

留言反馈

#技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
2007-08-01 10:28:00 | [匿名用户:WebServices]
#[转]技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
本文转自http://blog.joycode.com/scottgu/archive/2006/11/27/88083.aspx 其文如下技巧和诀窍:如何在Web.config中注册用户控件和自定...
2007-01-09 08:38:00 | [匿名用户:freeliver54]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
sddsdsdfsdfsdfsdfdsfsfsdfsdf
2006-12-07 12:19:00 | [匿名用户:sfsdf]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
这个可以确认,毕竟系统是可以运行的.
说明引用和被引用的项目都通过编译了.
问题只是不会有语法提示.全部是画上了红色的警告线,并未提示错误.
只是使用者感到迷茫,不晓得此控制有何语法,也就失去VS开发优势.
2006-11-29 16:10:00 | [匿名用户:joy]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
to joy:
你要确认正确引用了类库或项目,要确保引用的项目正确编译
2006-11-28 23:18:00 | [匿名用户:baoyu]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
步骤三可能没说清楚:
3. 在其中一个ascx(定为A)里用标签语法加载另一个ascx(定为B),再在aspx文件中用标签语法加载定为A的ascx,显然就出错了,系统会提示同一目录下控件互相嵌套
2006-11-28 14:02:00 | [匿名用户:飞行石]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
不知道有没有发现这个问题?

按步骤列出:
1. 在同一个子目录下建两个ascx,并分别在web.config下注册;
2. 分别在aspx里调用这两个ascx文件,均成功;
3. 将其中一个ascx(定为A)嵌入另一个ascx(定为B),再在aspx中调用定为B的那个ascx,页面就出错了
4. 将这两个ascx分别放在不同的子目录下,问题解决
-----------------------------------------
这个问题始终没有找到更好的解决方式
2006-11-28 13:56:00 | [匿名用户:飞行石]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
谢谢提供!
我只是会点ASP
2006-11-28 12:07:00 | [匿名用户:干洗加盟网]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
想请教一下,为什么我们自已开发的控件.
如果继承于 webControls的在应用到aspx中,却并不像
微软自带的一些控件,有语法提示!
如输入<asp:Text 后,按空格,就有语法提示,如果是我们自己开发的,输入<cst:Demo 就没有,并且还提示一些警告.不知如何处理噢?
2006-11-28 10:40:00 | [匿名用户:joy]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
偶在12月份的CSDN杂志上的一篇VS2005开发asp.net的文章中提到了这个小技巧:)
2006-11-27 12:03:00 | [匿名用户:baoyu]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
不错,原文是这样。我现在上面纠正了,谢谢!
2006-11-27 09:37:00 | [匿名用户:saucer]
#回复: 技巧和诀窍:如何在Web.config中注册用户控件和自定义控件 编辑
代码似乎有些错误?
web.config中注册的是tagPrefix="scottgu"
可是下面的代码却是<scott:header ID
2006-11-27 09:27:00 | [匿名用户:Dflying Chen]
对不起,目前本随笔不允许发表新评论.