ClientScriptManager.RegisterClientScriptBlock ClientScriptManager.RegisterClientScriptBlock ClientScriptManager.RegisterClientScriptBlock Method

定義

クライアント スクリプトを Page オブジェクトに登録します。Registers the client script with the Page object.

オーバーロード

RegisterClientScriptBlock(Type, String, String) RegisterClientScriptBlock(Type, String, String) RegisterClientScriptBlock(Type, String, String)

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

RegisterClientScriptBlock(Type, String, String, Boolean) RegisterClientScriptBlock(Type, String, String, Boolean) RegisterClientScriptBlock(Type, String, String, Boolean)

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

RegisterClientScriptBlock(Type, String, String) RegisterClientScriptBlock(Type, String, String) RegisterClientScriptBlock(Type, String, String)

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

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

パラメーター

type
Type Type Type

登録するクライアント スクリプトの型。The type of the client script to register.

key
String String String

登録するクライアント スクリプトのキー。The key of the client script to register.

script
String String String

登録するクライアント スクリプト リテラル。The client script literal to register.

次のコード例は、の使用を示します、RegisterClientScriptBlockメソッド。The following code example demonstrates the use of the RegisterClientScriptBlock 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 script on the page.
    String csName = "ButtonClickScript";
    Type csType = this.GetType();

    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(csType, csName))
    {
      StringBuilder csText = new StringBuilder();
      csText.Append("<script type=\"text/javascript\"> function DoClick() {");
      csText.Append("Form1.Message.value='Text from client script.'; }");
      csText.Append("</script>");
      cs.RegisterClientScriptBlock(csType, csName, csText.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">
    Public Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
        ' Define the name and type of the client script on the page. 
        Dim csName 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 client script is already registered. 
        If Not cs.IsClientScriptBlockRegistered(csType, csName) Then
            Dim csText As New StringBuilder()
            csText.Append("<script type=""text/javascript""> function DoClick() {")
            csText.Append("Form1.Message.value='Text from client script.'; }")
            csText.Append("</script>")
            cs.RegisterClientScriptBlock(csType, csName, csText.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>

注釈

クライアント スクリプトは、そのキーとその型で一意に識別されます。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.

呼び出す、IsClientScriptBlockRegisteredメソッドを指定したキーおよび種類のペアでクライアント スクリプトは既に登録されているかどうかを判断し、スクリプトを追加しようとして不必要を回避します。Call the IsClientScriptBlockRegistered method to determine whether a client script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

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

RegisterClientScriptBlockメソッドは、レンダリングされたページの上部にスクリプト ブロックを追加します。The RegisterClientScriptBlock method adds a script block to the top of the rendered page. スクリプト ブロックは、登録されている順序で出力されるとは限りません。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.

こちらもご覧ください

RegisterClientScriptBlock(Type, String, String, Boolean) RegisterClientScriptBlock(Type, String, String, Boolean) RegisterClientScriptBlock(Type, String, String, Boolean)

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

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

パラメーター

type
Type Type Type

登録するクライアント スクリプトの型。The type of the client script to register.

key
String String String

登録するクライアント スクリプトのキー。The key of the client script to register.

script
String String String

登録するクライアント スクリプト リテラル。The client script literal to register.

addScriptTags
Boolean Boolean Boolean

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

例外

クライアント スクリプト ブロックの型が null です。The client script block type is null.

次のコード例は、の使用を示します、RegisterClientScriptBlockメソッド。The following code example demonstrates the use of the RegisterClientScriptBlock method. なお、addScriptTagsにパラメーターが設定されているtrue開始と終了タグのスクリプトが付属していないため、scriptパラメーター。Note that the addScriptTags parameter is set to true so the beginning and closing script tags are not 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 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.

呼び出す、IsClientScriptBlockRegisteredメソッドを指定したキーおよび種類のペアでクライアント スクリプトは既に登録されているかどうかを判断します。Call the IsClientScriptBlockRegistered method to determine whether a client script with a given key and type pair is already registered. これにより、スクリプトを追加しようとして不必要に回避できます。This lets you avoid unnecessarily attempting to add the script.

このオーバー ロードで、RegisterClientScriptBlockメソッドで、スクリプトが提供されるかどうか示すことができます、scriptでパラメーターがラップされて、<script>要素のブロックを使用して、addScriptTagsパラメーター。In this overload of the RegisterClientScriptBlock 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.

RegisterClientScriptBlockメソッドは、レンダリングされたページの上部にスクリプト ブロックを追加します。The RegisterClientScriptBlock method adds a script block to the top of the rendered page. スクリプト ブロックは、登録されている順序で出力されるとは限りません。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.

こちらもご覧ください

適用対象