ClientScriptManager.IsClientScriptBlockRegistered メソッド

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

クライアントスクリプトブロックが Page オブジェクトに登録されているかどうかを判断します。

オーバーロード

IsClientScriptBlockRegistered(String)	指定されたキーを使用して、クライアントスクリプトブロックが Page オブジェクトに登録されているかどうかを判断します。
IsClientScriptBlockRegistered(Type, String)	キーと型を使用して、クライアントスクリプトブロックが Page オブジェクトに登録されているかどうかを判断します。

IsClientScriptBlockRegistered(String)

指定されたキーを使用して、クライアントスクリプトブロックが Page オブジェクトに登録されているかどうかを判断します。

public:
 bool IsClientScriptBlockRegistered(System::String ^ key);

public bool IsClientScriptBlockRegistered (string key);

member this.IsClientScriptBlockRegistered : string -> bool

Public Function IsClientScriptBlockRegistered (key As String) As Boolean

パラメーター

key: String

検索対象のクライアントスクリプトブロックのキー。

戻り値

Boolean

クライアントスクリプトブロックが登録されている場合は true。それ以外の場合は false。

例

<%@ 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);
    }

    // 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());
    }
  }
</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)
      
    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())
      
    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>

注釈

重複するスクリプトを登録しないようにするには、メソッドを RegisterClientScriptBlock 呼び出す前にこのメソッドを呼び出します。これは、スクリプトで大量のサーバーリソースを作成する必要がある場合に特に重要です。

クライアントスクリプトは、そのキーとその種類によって一意に識別されます。キーと種類が同じスクリプトは重複と見なされます。

メソッドのこのオーバーロードは、 IsClientScriptBlockRegistered 型がオブジェクトとして設定されたパラメーターとパラメーターの両方 key を type 受け取るオーバーロードを Page 呼び出します。

こちらもご覧ください

適用対象

IsClientScriptBlockRegistered(Type, String)

キーと型を使用して、クライアントスクリプトブロックが Page オブジェクトに登録されているかどうかを判断します。

public:
 bool IsClientScriptBlockRegistered(Type ^ type, System::String ^ key);

public bool IsClientScriptBlockRegistered (Type type, string key);

member this.IsClientScriptBlockRegistered : Type * string -> bool

Public Function IsClientScriptBlockRegistered (type As Type, key As String) As Boolean

パラメーター

type: Type

検索対象のクライアントスクリプトブロックの型。

key: String

検索対象のクライアントスクリプトブロックのキー。

戻り値

Boolean

クライアントスクリプトブロックが登録されている場合は true。それ以外の場合は false。

例外

ArgumentNullException

クライアントスクリプトの型が null. です。

例

次のコード例では、メソッドの使用方法を IsClientScriptBlockRegistered 示します。既存のクライアントスクリプトブロックをチェックするロジックが削除された場合、レンダリングされたページの HTML ソースコードに重複するクライアントスクリプトが 2 つ存在しないことに注意してください。これは、 RegisterClientScriptBlock メソッドが重複をチェックするためです。チェックの利点は、不要な計算を減らすことです。

<%@ 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>

注釈

クライアントスクリプトは、そのキーとその種類によって一意に識別されます。キーと種類が同じスクリプトは重複と見なされます。リソースにアクセスするオブジェクトに基づいて型を指定します。たとえば、インスタンスを Page 使用してリソースにアクセスする場合は、型を Page 指定します。

こちらもご覧ください

適用対象

ClientScriptManager.IsClientScriptBlockRegistered メソッド

定義

オーバーロード

IsClientScriptBlockRegistered(String)

パラメーター

戻り値

例

注釈

こちらもご覧ください

適用対象

IsClientScriptBlockRegistered(Type, String)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

フィードバック

その他のリソース