Page.RegisterStartupScript(String, String) メソッド

  • リファレンス

定義

名前空間:
System.Web.UI
アセンブリ:
System.Web.dll

注意事項

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

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

public:
 virtual void RegisterStartupScript(System::String ^ key, System::String ^ script);
public virtual void RegisterStartupScript (string key, string script);
[System.Obsolete("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);
abstract member RegisterStartupScript : string * string -> unit
override this.RegisterStartupScript : string * string -> unit
[<System.Obsolete("The recommended alternative is ClientScript.RegisterStartupScript(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")>]
abstract member RegisterStartupScript : string * string -> unit
override this.RegisterStartupScript : string * string -> unit
Public Overridable Sub RegisterStartupScript (key As String, script As String)

パラメーター

key
String

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

script
String

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

属性
ObsoleteAttribute

例

次のコード例では、 メソッドと メソッドを RegisterStartupScript 組み合わせて使用する方法を IsStartupScriptRegistered 示します。 メソッドによって IsStartupScriptRegistered 決定されたコード宣言ブロックに記述された ECMAScript がまだ登録されていない場合は、呼び出し RegisterStartupScript が行われます。

<%@ Page Language="C#"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  public void Page_Load(Object sender, EventArgs e)
  {
    String csname1 = "PopupScript";
    String csname2 = "ButtonClickScript";

    if (!IsClientScriptBlockRegistered(csname1))
    {
        String cstext1 = "<script type=\"text/javascript\">" +
            "alert('Hello World');</" + "script>";
        RegisterStartupScript(csname1, cstext1);
    }

    if (!IsClientScriptBlockRegistered(csname2))
    {
      StringBuilder cstext2 = new StringBuilder();
      cstext2.Append("<script type=\"text/javascript\"> function DoClick() {");
      cstext2.Append("Form1.Message.value='Text from client script.'} </");
      cstext2.Append("script>");
      RegisterClientScriptBlock(csname2, cstext2.ToString());
    }
  }
</script>
<html  >
  <head>
    <title>RegisterClientScriptBlock Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>


<%@ Page Language="VB"  %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        Dim csname1 As String = "PopupScript"

        Dim csname2 As String = "ButtonClickScript"
    
        If Not IsClientScriptBlockRegistered(csname1) Then
            Dim cstext1 As String = "<script type=""text/javascript"">" & _
                "alert('Hello World');</" & "script>"
            RegisterStartupScript(csname1, cstext1)
        End If
    
        If Not IsClientScriptBlockRegistered(csname2) Then
            Dim cstext2 As New StringBuilder()
            cstext2.Append("<script type=""text/javascript""> function DoClick() {")
            cstext2.Append("Form1.Message.value='Text from client script.'} </")
            cstext2.Append("script>")
            RegisterClientScriptBlock(csname2, cstext2.ToString())
        End If
    End Sub
</script>
<html  >
  <head>
    <title>RegisterClientScriptBlock Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>

注釈

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

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

同じ key パラメーター値を持つスクリプト ブロックは、重複していると見なされます。

注意

要求側のブラウザーでスクリプトがサポートされていない場合はレンダリングされないように、スクリプトの周囲に HTML コメント タグを含める必要があります。

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

適用対象

こちらもご覧ください