設定自訂ASP.NET伺服器控制項TagPrefix的幾種方法

這兩天看《道不遠人-----深入解析ASP.NET2.0控制項開發》這本書，看完第二章內容後，想總結下“設定自訂ASP.NET伺服器控制項TagPrefix的幾種方法”，以便以後查閱，以下面code編寫的控制項為例，由於重點不是控制項編寫，所以寫了個非常簡單的控制項，姑且叫它EmailInput 

 1using System; 2using System.Collections.Generic; 3using System.ComponentModel; 4using System.Text; 5using System.Web; 6using System.Web.UI; 7using System.Web.UI.WebControls; 8 9namespace ServerControl10{11    [ToolboxData("<{0}:EmailInput runat=server></{0}:EmailInput>")]12    public class EmailInput : CompositeControl13    {14        protected RegularExpressionValidator _regValidator;15        protected RequiredFieldValidator _rqrValidatator;16        protected TextBox _input;17        protected override HtmlTextWriterTag TagKey18        {19            get20            {21                return HtmlTextWriterTag.Div;22            }23        }24        protected override void CreateChildControls() 25        {26            Controls.Clear();27            _input = new TextBox();28            _input.ID = "txtEmail";2930            _rqrValidatator = new RequiredFieldValidator();31            _rqrValidatator.ID = "rqvEmail";32            _rqrValidatator.ErrorMessage = "請輸入郵件地址";33            _rqrValidatator.Text = "*";34            _rqrValidatator.Display = ValidatorDisplay.Dynamic;35            _rqrValidatator.ControlToValidate = _input.ID;3637            _regValidator = new RegularExpressionValidator();38            _regValidator.ID = "revEmail";39            _regValidator.Display = ValidatorDisplay.Dynamic;40            _regValidator.ErrorMessage = "郵件格式錯誤";41            _regValidator.Text = "*";42            _regValidator.ValidationExpression = @"\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*";43            _regValidator.ControlToValidate = _input.ID;4445            this.Controls.Add(_input);46            this.Controls.Add(_rqrValidatator);47            this.Controls.Add(_regValidator);4849            ChildControlsCreated = true;50        }51    }52}

方法一、在Web.config中配置,具體做法為:在Web.config檔案的System.web節中添加如下代碼

Code1<pages>2  <controls>3     <add assembly="ServerControl" namespace="ServerControl" tagPrefix="sc"/>4  </controls>5</pages>

         說明：assembly表示控制項所在的程式集名稱，namespace表示控制項的命名空間，tagPrefix就是我們所要設定的項了

方法二、在使用該控制項的頁面添加<%Register%>指令，如下

Code1<%@ Register assembly="ServerControl" namespace="ServerControl" tagprefix="sc" %>

 說明：assembly表示控制項所在的程式集名稱，namespace表示控制項的命名空間，tagPrefix就是我們所要設定的項了

方法三、通過裝飾Attribute來指定tagPrefix，例如在控制項類添加如下Attribute

Code[assembly: TagPrefix("ServerControl", "scsc")]namespace ServerControl{    [ToolboxData("<{0}:EmailInput runat=server></{0}:EmailInput>")]    public class EmailInput : CompositeControl    {

說明：即使這樣定義了，每個頁面也都要添加<%Register%>指令，這樣只是提供了統一的tagPrefix，實質上還是第二種方法

方法四、在控制項項目中添加屬性檔案"Assembly.cs"中添加如下代碼來自訂控制項的首碼：

Codeusing System.Reflection;using System.Runtime.CompilerServices;using System.Runtime.InteropServices;using System.Web.UI;[assembly: TagPrefix("ServerControl","scsc")]

說明：即使這樣定義了，每個頁面也都要添加<%Register%>指令,這樣只是提供了統一的tagPrefix，實質上還是第二種方法

 

最後對上面的四種方法進行說明：

• 在Web.config中進行自訂是屬於應用程式層級的定義，只註冊一次即可對整個應用程式有效。其他三種方法都得在引用該控制項的頁面添加<%Register%>指令
• asp.net定義tagPrefix的檢測順序是：assemblyInfo.cs---->控制項中的attribute裝飾----->webconfig中的配置，也就是說，如果這幾種方法您都設定了，那麼asp.net 將會採用webconfig的設定方式！相信這也是asp.net覆蓋的簡單道理了！
• asp.net的內建控制項採用了第一種方法，即在 web.config中進行了配置，將tagPrefix配置成了asp，如果您看著不爽，可以改掉它。

 

 

以上純屬看書心得，如有錯誤，懇請您指正！