摘要:技巧和訣竅:如何在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="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 部分宣告一次即可:
<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 檔案中宣告好這些控制項後,你就可以在你網站上的任何一個頁面,母板頁或者用戶控制項中使用它們了,像這樣(不再需要註冊指令):
<body>
<form id="form1" runat="server">
<scottgu:header ID="MyHeader" runat="server" />
</form>
</body>
</html>
希望本文對你有所幫助,
Scott
附註:特別感謝 Phil Haack ,他在這個月的早先時候也曾在部落格裡討論過這個技巧。對你們中間那些不認識 Phil 的人,他幫忙建造了非常受歡迎的 SubText部落格引擎,而且擁有一個非常精彩的部落格。