DIV CSS 佈局教程網

在 ASP.NET 中用 JS/jQuery 正確取得伺服器控制項的 ClientID
編輯:關於JavaScript     

在 ASP.NET Web Forms 裡寫 JavaScript 時,最常見的挫折莫過於:document.getElementById('newsId') 永遠抓不到元素。原因不是 JS 寫錯,而是伺服器控制項在渲染成 HTML 時,id 屬性會被自動加上命名容器的名稱前綴(例如 ctl00_ContentPlaceHolder1_newsId)。

步驟一:取得伺服器控制項對應的用戶端 id

ASP.NET 提供了 ClientID 屬性,正好就是該控制項在瀏覽器端實際生成的 id。用 <%= %> 即可在伺服器端把它輸出到 JS 中:

<%= newsId.ClientID %>

步驟二:用 jQuery 取得對應的 DOM 元素

原生 document.getElementById 與 jQuery 都可以,這裡以 jQuery 示範:

var newsId = $("#<%= newsId.ClientID %>");

步驟三:進行操作

拿到元素之後,剩下的就是一般的 DOM 操作了:

var $newsId = $("#<%= newsId.ClientID %>");
$newsId.val('新的標題');
$newsId.addClass('highlight');

幾個實務上的補充

  • ClientID 與 UniqueID 的差別:ClientID 是渲染到 HTML 的 id;UniqueID 則是用 $ 分隔、供伺服器端事件回傳(postback)辨識用的名稱,兩者不可混用。
  • StaticClientID:若希望 id 不被改寫,可將控制項的 ClientIDMode 設為 Static,此後就能放心寫 $('#newsId')。這在 .NET 4.0 之後才提供。
  • 避免把 <%= %> 寫進外部 .js 檔:外部檔案不經過 ASP.NET 處理引擎,標籤不會被替換。若一定要分離,可在頁面中宣告變數再由外部腳本讀取:
<script>
  window.__config = { newsId: '<%= newsId.ClientID %>' };
</script>
<script src="js/news.js"></script>
  • 值得留意:Web Forms 已是維護性質的技術。若正在開發新專案, Razor Pages、MVC 或 Blazor 中並不存在這種 id 改寫問題,直接寫 #newsId 即可。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved