Page.RegisterStartupScript メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Page.RegisterStartupScript メソッド

メモ : このメソッドは、互換性のために残されています。

ページ応答で、クライアント側のスクリプトブロックを出力します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<ObsoleteAttribute("The recommended alternative is ClientScript.RegisterStartupScript(Type
 type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")>
 _
Public Overridable Sub RegisterStartupScript
 ( _
    key As String, _
    script As String _
)

Visual Basic (使用法)

Dim instance As Page
Dim key As String
Dim script As String

instance.RegisterStartupScript(key, script)

[ObsoleteAttribute("The recommended alternative is ClientScript.RegisterStartupScript(Type
 type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")]
 
public virtual void RegisterStartupScript (
    string key,
    string script
)

C++

[ObsoleteAttribute(L"The recommended alternative is ClientScript.RegisterStartupScript(Type
 type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")]
 
public:
virtual void RegisterStartupScript (
    String^ key, 
    String^ script
)

/** @attribute ObsoleteAttribute("The recommended alternative is ClientScript.RegisterStartupScript(Type
 type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")
 */ 
public void RegisterStartupScript (
    String key, 
    String script
)

JScript

ObsoleteAttribute("The recommended alternative is ClientScript.RegisterStartupScript(Type
 type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")
 
public function RegisterStartupScript (
    key : String, 
    script : String
)

パラメータ

key: スクリプトブロックを識別する一意のキー。

script: クライアントに送られるスクリプトの内容。

解説

RegisterStartupScript メソッドは、RegisterClientScriptBlock メソッドと同様に、Page オブジェクトの <form runat= server> 要素の終了タグの直前にスクリプトを出力します。script パラメータで指定したスクリプトブロックの文字列を、必ず開始と終了の <script> 要素で囲んでください。

このメソッドは、キーを使用してスクリプトブロックを識別するので、異なるサーバーコントロールのインスタンスから要求されるたびにスクリプトブロックを出力ストリームに出力する必要はありません。

同じ key パラメータ値のスクリプトブロックは、重複であると見なされます。

メモ
要求側のブラウザがスクリプトをサポートしていない場合にスクリプトが表示されないように、HTML コメントタグでスクリプトを囲んでおいてください。

RegisterStartupScript メソッドは推奨されていません。代わりに ClientScriptManager クラスの RegisterStartupScript メソッドを使用してください。

使用例

IsStartupScriptRegistered メソッドと共に RegisterStartupScript メソッドを使用する方法を次のコード例に示します。コード宣言ブロックに書き込まれた ECMAScript がまだ登録されていないことが IsStartupScriptRegistered メソッドによるチェックで判明した場合は、RegisterStartupScript の呼び出しが実行されます。

Visual Basic

<html>
  <head>
     <script language="VB" runat="server">
       Public Sub Page_Load(ByVal
 Sender As Object, ByVal
 e As EventArgs)
         If (Not Me.IsStartupScriptRegistered("Startup"))
 Then
           ' Form the script to be registered at client side.
           Dim scriptString As String
 = "<script language=JavaScript> function DoClick() {"
           scriptString += "showMessage2.innerHTML='<h4>Welcome
 to Microsoft .NET!</h4>'}"
           scriptString += "function Page_Load(){ showMessage1.innerHTML="
           scriptString += "'<h4>RegisterStartupScript Example</h4>'}<"
           scriptString += "/"
           scriptString += "script>"
           Me.RegisterStartupScript("Startup",
 scriptString)
         End If
       End Sub
        </script>
  </head>
  <body topmargin="20" leftmargin="10"
 onload="Page_Load()">
     <form id="myForm" runat="server">
        <span id="showMessage1"></span>
        <br>
        <input type="button" value="ClickMe"
 onclick="DoClick()">
        <br>
        <span id="showMessage2"></span>
     </form>
  </body>
</html>

<html>
  <head>
    <script language="C#" runat="server">
      public void Page_Load(Object sender,
 EventArgs e)
      {

        if (!this.IsStartupScriptRegistered("Startup"))
        {
          // Form the script to be registered at client side.
          String scriptString = "<script language=JavaScript> function
 DoClick() {";
          scriptString += "showMessage2.innerHTML='<h4>Welcome to Microsoft
 .NET!</h4>'}";
          scriptString += "function Page_Load(){ showMessage1.innerHTML=";
          scriptString += "'<h4>RegisterStartupScript Example</h4>'}<";
          scriptString += "/";
          scriptString += "script>";
          this.RegisterStartupScript("Startup", scriptString);
        }
      }
     </script>
  </head>
  <body topmargin="20" leftmargin="10" onload="Page_Load()">
     <form id="myForm" runat="server">
        <span id="showMessage1"></span>
        <br>
        <input type="button" value="ClickMe" onclick="DoClick()">
        <br>
        <span id="showMessage2"></span>
     </form>
  </body>
</html>

<html>
    <head>
        <script language="VJ#" runat="server">
          public void Page_Load(Object sender,
 EventArgs e)
          {

            if (!(this.IsStartupScriptRegistered("Startup")))
            {
              // Form the script to be registered at client side.
              String scriptString = "<script language=JavaScript> function
 DoClick() {";
              scriptString += "showMessage2.innerHTML='<h4>Welcome"
 
                + " to Microsoft .NET!</h4>'}";
              scriptString += "function Page_Load(){ showMessage1.innerHTML=";
              scriptString += "'<h4>RegisterStartupScript Example</h4>'}<";
              scriptString += "/";
              scriptString += "script>";
              this.RegisterStartupScript("Startup",
 scriptString);
            }
          } 
        </script>
    </head>
    <body topmargin="20" leftmargin="10" onload="Page_Load()">
        <form id="myForm" runat="server">
            <span id="showMessage1"></span>
            <br>
            <input type="button" value="ClickMe" onclick="DoClick()">
            <br>
            <span id="showMessage2"></span>
        </form>
    </body>
</html>