DIV CSS 佈局教程網

ASP.NET 伺服器控制項中註冊 JavaScript 的三種寫法
編輯:關於JavaScript     

自製伺服器控制項時,前端腳本要跟著控制項一起輸出,常見有三種等級的做法:直接把腳本寫死在 Render 裡、從組件資源讀檔後輸出、以及註冊成啟動腳本。三者適用情境不同,以下分別說明。

方法一:靜態字串直接寫入

最直覺的做法是把腳本當成常數,在 Render 覆寫中寫出。適合腳本極短、完全不會變動的情況。

#region 靜態 javascript 腳本
const string sScript = @"<script type=""text/javascript"" language='javascript'>
    ... 這裡放你的腳本 ...
</script>";
#endregion

protected override void Render(HtmlTextWriter output)
{
    output.Write(sScript);
    base.Render(output);
}

要注意字串裡的雙引號必須寫成兩個連續引號(@"" 逐字字串語法),而且別忘了呼叫 base.Render,否則控制項本身的 HTML 不會輸出。

方法二:從組件內嵌資源讀取後輸出

把 .js 檔設為「內嵌資源」(Build Action = Embedded Resource),執行時用 GetManifestResourceStream 讀出來。這樣腳本可以獨立維護、享有語法高亮,不必和 C# 字串糾纏。

using (StreamReader reader = new StreamReader(
        this.GetType().Assembly.GetManifestResourceStream(
            GetType(), "jsName.js")))
{
    string sJsSlider = reader.ReadToEnd();
    output.Write(sJsSlider);
}

資源名稱的組成規則是「預設命名空間.資料夾.檔名」,若一直讀到 null,第一個要檢查的就是這個字串是否吻合。

方法三:註冊為啟動腳本

如果腳本必須在頁面所有控制項都就位之後才執行,就該用 RegisterStartupScript,讓它被放到表單尾端而非混在中間。

using (StreamReader reader = new StreamReader(
        this.GetType().Assembly.GetManifestResourceStream(
            GetType(), "jsName.js")))
{
    string sJsStart = reader.ReadToEnd();
    Page.RegisterStartupScript(
        this.GetType().ToString() + this.UniqueID + "_Startup", sJsStart);
}

第二個參數是「金鑰」。同一頁面上若有多個控制項實例,每個都要有自己專屬的腳本,因此這裡把型別全名與 UniqueID 串在一起當 key,可以確保多實例時不會互相覆蓋。

怎麼選?

腳本小且不變,用方法一;腳本有規模、需要獨立維護,用方法二;腳本依賴 DOM 完成、或有多實例需要各自初始化,用方法三。實務上常見的組合是「方法二讀檔 + 方法三註冊」,兼得可維護性與執行時機的正確性。

另外提醒,這三種寫法都屬於早期 Web Forms 的 Page.ClientScript 家族;在現代 ASP.NET 中,RegisterStartupScript 已標記為過時,建議改用 ClientScriptManager.RegisterStartupScript 並搭配 SupportsWebForms 檢查,或直接改用腳本管理與資源對映的方式處理。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved