萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET tagMapping 將內建控制項對應至自訂控制項 (無需修改頁面標記)

tagMapping 機制簡介

`` 允許在 **編譯階段** 將特定控制項類型 (如 `asp:Label`) 自動重新導向至自訂衍生類別 (如 `MyProject.Controls.EnhancedLabel`),**所有現有 `.aspx` 頁面無需修改任何標記**,即可統一套用自訂行為 (如預設 CSS Class、XSS 防護、多語系)。

Web.config 設定

<configuration>
  <system.web>
    <pages>
      <tagMapping>
        <!-- 將所有 asp:Label 對應至自訂 EnhancedLabel -->
        <add tagType="System.Web.UI.WebControls.Label" 
             mappedTagType="MyProject.Controls.EnhancedLabel, MyProject" />
        
        <!-- 將 GridView 對應至自訂 GridViewEx (支援匯出、固定表頭) -->
        <add tagType="System.Web.UI.WebControls.GridView" 
             mappedTagType="MyProject.Controls.GridViewEx, MyProject" />
        
        <!-- WebPartManager 對應 SharePoint 相容實作 -->
        <add tagType="System.Web.UI.WebControls.WebParts.WebPartManager" 
             mappedTagType="Microsoft.SharePoint.WebPartPages.SPWebPartManager, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
      </tagMapping>
    </pages>
  </system.web>
</configuration>

自訂控制項實作範例

EnhancedLabel.cs - 自動加入 CSS Class 與 HTML 編碼

namespace MyProject.Controls
{
    public class EnhancedLabel : System.Web.UI.WebControls.Label
    {
        protected override void OnPreRender(EventArgs e)
        {
            // 1. 確保 CssClass 包含基礎樣式
            if (!CssClass.Contains("form-label")) CssClass += " form-label";

            // 2. 自動 HTML 編碼 Text (防 XSS),除非明確設定 Encode="false"
            // 需自行擴充 Encode 屬性 (略)
            
            base.OnPreRender(e);
        }

        protected override void RenderContents(HtmlTextWriter writer)
        {
            // 範例:在文字前加前綴
            writer.Write("【標籤】");
            base.RenderContents(writer);
        }
    }
}

GridViewEx.cs - 內建匯出 Excel 功能

public class GridViewEx : GridView
{
    public override void VerifyRenderingInServerForm(Control control) { } // 允許 RenderControl 匯出

    public void ExportToExcel(string fileName)
    {
        Response.Clear();
        Response.ContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
        Response.AddHeader("Content-Disposition", $"attachment;filename={fileName}.xlsx");
        // 使用 EPPlus/NPOI 產生真正 .xlsx (略)
        Response.End();
    }
}

原始頁面標記 (完全不變)

<asp:Label ID="lblTitle" runat="server" Text="標題" CssClass="title" />
<asp:GridView ID="gvData" runat="server" AutoGenerateColumns="True" />

編譯後實際產生的 HTML (EnhancedLabel 介入後)

<span id="lblTitle" class="title form-label">【標籤】標題</span>
<div class="gridviewex">...</div>

適用條件與限制

條件說明
目標類別需為 public 且可實例化不可為 abstract / internal
需繼承原控制項類別`mappedTagType` 必須繼承 `tagType`
僅影響伺服器端控制項純 HTML 標籤 (`
需重新編譯網站修改 web.config 後需 Rebuild / IIS 重啟
不支援泛型控制項如 `GridView` (Web Forms 無此類別)

適用場景

  • 全站統一加入防 XSS 編碼、無障礙 `aria-label`、設計系統 CSS Class。
  • 第三方控制項庫升級介面,舊專案零修改遷移。
  • 多語系專案自動注入資源鍵值邏輯。
  • SharePoint 整合專案對應 `WebPartManager`。
copyright © 萬盛學電腦網 all rights reserved