ClientScriptManager.RegisterStartupScript ClientScriptManager.RegisterStartupScript ClientScriptManager.RegisterStartupScript Method

定義

スタートアップ スクリプトを Page オブジェクトに登録します。Registers the startup script with the Page object.

オーバーロード

RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String)

型、キー、およびスクリプト リテラルを使用して、Page オブジェクトにスタートアップ スクリプを登録します。Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean)

型、キー、スクリプト リテラル、およびスクリプト タグを追加するかどうかを示すブール値を使用して、スタートアップ スクリプを Page オブジェクトに登録します。Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String)

型、キー、およびスクリプト リテラルを使用して、Page オブジェクトにスタートアップ スクリプを登録します。Registers the startup script with the Page object using a type, a key, and a script literal.

public:
 void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script);
public void RegisterStartupScript (Type type, string key, string script);
member this.RegisterStartupScript : Type * string * string -> unit

パラメーター

type
Type Type Type

登録するスタートアップ スクリプの型。The type of the startup script to register.

key
String String String

登録するスタートアップ スクリプトのキー。The key of the startup script to register.

script
String String String

登録するスタートアップ スクリプ リテラル。The startup script literal to register.

次のコード例は、 RegisterStartupScriptメソッドの使用方法を示しています。The following code example demonstrates the use of the RegisterStartupScript method. パラメーターにscriptは、開始および終了のスクリプトタグが含まれていることに注意してください。Note that the beginning and closing script tags are included within the script parameter. 追加のパラメーター設定に基づいてスクリプトタグを追加するには、 RegisterStartupScriptメソッドを参照してください。To have the script tags added based on an additional parameter setting, see the RegisterStartupScript method.

<%@ 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)
  {
    // Define the name and type of the client scripts on the page.
    String csname1 = "PopupScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the startup script is already registered.
    if (!cs.IsStartupScriptRegistered(cstype, csname1))
    {
        StringBuilder cstext1 = new StringBuilder();
        cstext1.Append("<script type=text/javascript> alert('Hello World!') </");
        cstext1.Append("script>");

        cs.RegisterStartupScript(cstype, csname1, cstext1.ToString());
    }
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>RegisterStartupScript</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
    </div>
    </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">
    Public Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
        ' Define the name and type of the client scripts on the page. 
        Dim csname1 As [String] = "PopupScript"
        Dim cstype As Type = Me.[GetType]()
    
        ' Get a ClientScriptManager reference from the Page class. 
        Dim cs As ClientScriptManager = Page.ClientScript
    
        ' Check to see if the startup script is already registered. 
        If Not cs.IsStartupScriptRegistered(cstype, csname1) Then
            Dim cstext1 As New StringBuilder()
            cstext1.Append("<script type=text/javascript> alert('Hello World!') </")
            cstext1.Append("script>")
        
            cs.RegisterStartupScript(cstype, csname1, cstext1.ToString())
        End If
    End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>RegisterStartupScript</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
    </div>
    </form>
</body>
</html>

注釈

クライアントスクリプトは、キーとその型によって一意に識別されます。A client script is uniquely identified by its key and its type. 同じキーと種類のスクリプトは重複していると見なされます。Scripts with the same key and type are considered duplicates. ページに登録できるのは、指定された型とキーのペアを持つスクリプト1つだけです。Only one script with a given type and key pair can be registered with the page. 既に登録されているスクリプトを登録しようとしても、スクリプトの複製は作成されません。Attempting to register a script that is already registered does not create a duplicate of the script.

IsStartupScriptRegisteredメソッドを呼び出して、指定したキーと型のペアを持つスタートアップスクリプトが既に登録されているかどうかを確認し、不必要にスクリプトを追加しようとしないようにします。Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

RegisterStartupScriptメソッドのこのオーバーロードでは、 script <script>パラメーターに指定されたスクリプトが要素ブロックでラップされていることを確認する必要があります。In this overload of the RegisterStartupScript method, you must make sure that the script provided in the script parameter is wrapped with a <script> element block.

RegisterStartupScriptメソッドによって追加されたスクリプトブロックは、ページの読み込みが完了しOnLoadた後、ページのイベントが発生する前に実行されます。The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. スクリプトブロックは、登録されている順序で出力されるとは限りません。The script blocks are not guaranteed to be output in the order they are registered. スクリプトブロックの順序が重要な場合は、オブジェクトをStringBuilder使用してスクリプトを1つの文字列でまとめて収集し、そのすべてを1つのクライアントスクリプトブロックに登録します。If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

こちらもご覧ください

RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean)

型、キー、スクリプト リテラル、およびスクリプト タグを追加するかどうかを示すブール値を使用して、スタートアップ スクリプを Page オブジェクトに登録します。Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

public:
 void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script, bool addScriptTags);
public void RegisterStartupScript (Type type, string key, string script, bool addScriptTags);
member this.RegisterStartupScript : Type * string * string * bool -> unit

パラメーター

type
Type Type Type

登録するスタートアップ スクリプの型。The type of the startup script to register.

key
String String String

登録するスタートアップ スクリプトのキー。The key of the startup script to register.

script
String String String

登録するスタートアップ スクリプ リテラル。The startup script literal to register.

addScriptTags
Boolean Boolean Boolean

スクリプト タグを追加するかどうかを示すブール値。A Boolean value indicating whether to add script tags.

例外

次のコード例は、 RegisterStartupScriptメソッドの使用方法を示しています。The following code example demonstrates the use of the RegisterStartupScript method. パラメーターがにaddScriptTags false設定されていることに注意してください。これによりscript 、スクリプトの開始タグと終了タグがパラメーターに含まれるようになります。Note that the addScriptTags parameter is set to false so the beginning and closing script tags are included with the script parameter.

<%@ 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)
  {
    // Define the name and type of the client scripts on the page.
    String csname1 = "PopupScript";
    String csname2 = "ButtonClickScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the startup script is already registered.
    if (!cs.IsStartupScriptRegistered(cstype, csname1))
    {
      String cstext1 = "alert('Hello World');";
      cs.RegisterStartupScript(cstype, csname1, cstext1, true);
    }

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(cstype, 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>");
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), false);
    }
  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager 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 System.EventArgs)

    ' Define the name and type of the client scripts on the page.
    Dim csname1 As String = "PopupScript"
    Dim csname2 As String = "ButtonClickScript"
    Dim cstype As Type = Me.GetType()
    
    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript

    ' Check to see if the startup script is already registered.
    If (Not cs.IsStartupScriptRegistered(cstype, csname1)) Then
      
      Dim cstext1 As String = "alert('Hello World');"
      cs.RegisterStartupScript(cstype, csname1, cstext1, True)
      
    End If
    
    ' Check to see if the client script is already registered.
    If (Not cs.IsClientScriptBlockRegistered(cstype, 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>")
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), False)
      
    End If
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>

注釈

スタートアップスクリプトは、キーとその型によって一意に識別されます。A startup script is uniquely identified by its key and its type. 同じキーと種類のスクリプトは重複していると見なされます。Scripts with the same key and type are considered duplicates. ページに登録できるのは、指定された型とキーのペアを持つスクリプト1つだけです。Only one script with a given type and key pair can be registered with the page. 既に登録されているスクリプトを登録しようとしても、スクリプトの複製は作成されません。Attempting to register a script that is already registered does not create a duplicate of the script.

IsStartupScriptRegisteredメソッドを呼び出して、指定したキーと型のペアを持つスタートアップスクリプトが既に登録されているかどうかを確認し、不必要にスクリプトを追加しようとしないようにします。Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

RegisterStartupScriptメソッドのこのオーバーロードでは、パラメーター scriptに指定されたスクリプトが、 addScriptTagsパラメーターを使用して<script>要素ブロックでラップされているかどうかを示すことができます。In this overload of the RegisterStartupScript method, you can indicate whether the script provided in the script parameter is wrapped with a <script> element block by using the addScriptTags parameter. addScriptTagstrue設定すると、スクリプトタグが自動的に追加されます。Setting addScriptTags to true indicates that script tags will be added automatically.

RegisterStartupScriptメソッドによって追加されたスクリプトブロックは、ページの読み込みが完了しOnLoadた後、ページのイベントが発生する前に実行されます。The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. スクリプトブロックは、登録されている順序で出力されるとは限りません。The script blocks are not guaranteed to be output in the order they are registered. スクリプトブロックの順序が重要な場合は、オブジェクトをStringBuilder使用してスクリプトを1つの文字列でまとめて収集し、そのすべてを1つのクライアントスクリプトブロックに登録します。If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

こちらもご覧ください

適用対象