ASP.NET 服務器控件渲染為 HTML 時,其 id 屬性會被框架修改 (如 ctl00_ContentPlaceHolder1_btnSubmit),導致前端腳本無法通過原始 ID 選中元素。本文詳解獲取 ClientID 的標準方法及最佳實踐。
ASP.NET 控件的 ClientID 屬性包含瀏覽器端真實渲染的 HTML 元素 id。需在服務端代碼塊中輸出此值供前端使用。
<script>
// 直接在頁面內聯輸出 ClientID
var btnId = '<%= btnSubmit.ClientID %>';
var txtId = '<%= txtName.ClientID %>';
// 配合 jQuery 使用
var $btn = $('#' + btnId); // 或 $('#<%= btnSubmit.ClientID %>')
var $txt = $('#<%= txtName.ClientID %>');
</script>
// Page_Load 或事件中
string script = $@"
var btnId = '{btnSubmit.ClientID}';
var txtId = '{txtName.ClientID}';
";
ScriptManager.RegisterStartupScript(this, GetType(), "clientIds", script, true);
public static string GetClientId(Control control) {
return control.ClientID;
}
// 頁面中
var btnId = '<%= Helpers.GetClientId(btnSubmit) %>';
// 單個元素
var $control = $('#<%= myControl.ClientID %>');
// 多個元素批量獲取
var ids = {
btnSave: '<%= btnSave.ClientID %>',
txtName: '<%= txtName.ClientID %>',
ddlCategory: '<%= ddlCategory.ClientID %>'
};
var $btnSave = $('#' + ids.btnSave);
// 站點通用 JS 文件
window.$asp = function(serverId) {
// 假設頁面已定義 window.aspClientIds = { serverId: clientId, ... }
return $('#' + (window.aspClientIds?.[serverId] || serverId));
};
// 頁面註冊映射 (一次性輸出)
<script>
window.aspClientIds = {
btnSave: '<%= btnSave.ClientID %>',
txtName: '<%= txtName.ClientID %>',
// ...
};
</script>
// 極簡調用
$asp('btnSave').click(...);
$asp('txtName').val('test');
<asp:Button ID="btnSave" runat="server" CssClass="btn-save" />
// JS 中直接用類選擇器,不依賴 ClientID
$('.btn-save').click(function() { ... });
優勢: 完全解耦前後端 ID,支持母版頁、用戶控件、重複控件 (ListView/Repeater) 自動生成的多實例。
模板控件內的控件會生成多個實例,ClientID 包含行索引 (如 rptItems_ctl02_btnEdit)。
避免前端 JS 直接操作模板內控件,使用 ASP.NET 內置命令事件。
<asp:Repeater ID="rptItems" runat="server">
<ItemTemplate>
<button class="btn-edit" data-item-id="<%# Eval('Id') %>">編輯</button>
</ItemTemplate>
</asp:Repeater>
<script>
$('.btn-edit').click(function() {
var itemId = $(this).data('item-id'); // 獲取業務標識
// AJAX 請求...
});
</script>
| 框架 | ID 生成 | 前端獲取方式 |
|---|---|---|
| WebForms | 自動生成 (ctl00_...) | ClientID 屬性、CssClass、data-* |
| MVC / Razor Pages | 手動指定或 TagHelper 自動生成 | 直接用指定 id、asp-for 生成的 id |
| Blazor | 內部渲染樹,無實際 DOM ID | @ref、EventCallback、JS Interop |
<%@ Page Language="C#" %>
<html>
<head>
<script src="jquery-3.6.0.min.js"></script>
<script>
// 方案1: 直接內聯
$('#<%= btnSubmit.ClientID %>').click(function() {
var name = $('#<%= txtName.ClientID %>').val();
alert('Hello ' + name);
});
// 方案2: 映射表 (適用於多控件)
window.aspIds = {
btnSubmit: '<%= btnSubmit.ClientID %>',
txtName: '<%= txtName.ClientID %>'
};
function $asp(id) { return $('#' + (window.aspIds[id] || id)); }
$asp('btnSubmit').click(...);
</script>
</head>
<body>
<form id="form1" runat="server">
<asp:TextBox ID="txtName" runat="server" />
<asp:Button ID="btnSubmit" runat="server" Text="提交" />
</form>
</body>
</html>
ClientID 獲取真實渲染 ID<%= control.ClientID %> 是最直接方法window.aspClientIds 映射表統一管理