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

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

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

Page.IsClientScriptBlockRegistered メソッド

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

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

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

Visual Basic (宣言)

<ObsoleteAttribute("The recommended alternative is ClientScript.IsClientScriptBlockRegistered(string
 key). http://go.microsoft.com/fwlink/?linkid=14202")> _
Public Function IsClientScriptBlockRegistered
 ( _
    key As String _
) As Boolean

Visual Basic (使用法)

Dim instance As Page
Dim key As String
Dim returnValue As Boolean

returnValue = instance.IsClientScriptBlockRegistered(key)

[ObsoleteAttribute("The recommended alternative is ClientScript.IsClientScriptBlockRegistered(string
 key). http://go.microsoft.com/fwlink/?linkid=14202")] 
public bool IsClientScriptBlockRegistered (
    string key
)

C++

[ObsoleteAttribute(L"The recommended alternative is ClientScript.IsClientScriptBlockRegistered(string
 key). http://go.microsoft.com/fwlink/?linkid=14202")] 
public:
bool IsClientScriptBlockRegistered (
    String^ key
)

/** @attribute ObsoleteAttribute("The recommended alternative is ClientScript.IsClientScriptBlockRegistered(string
 key). http://go.microsoft.com/fwlink/?linkid=14202") */ 
public boolean IsClientScriptBlockRegistered (
    String key
)

JScript

ObsoleteAttribute("The recommended alternative is ClientScript.IsClientScriptBlockRegistered(string
 key). http://go.microsoft.com/fwlink/?linkid=14202") 
public function IsClientScriptBlockRegistered
 (
    key : String
) : boolean

パラメータ

key: 検索対象のクライアントスクリプトの文字列キー。

戻り値
スクリプトブロックが登録されている場合は true。それ以外の場合は false。

解説

Page.RegisterClientScriptBlock を呼び出す前にこのメソッドを呼び出して、クライアント側のスクリプトを不必要にアセンブルしないようにします。この処理は、特に、スクリプトを作成するために大量のサーバーリソースが必要である場合に行ってください。

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

使用例

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

Visual Basic

<html>
  <head>
     <script language="VB" runat="server">
       
       Sub Page_Load(ByVal sender As
 Object, ByVal e As EventArgs)
         
         If (Not IsClientScriptBlockRegistered("clientScript"))
 Then
           
           'Form the script that is to be registered at client side.
           Dim scriptString As String
 = "<script language=JavaScript> function DoClick() {"
           scriptString += "myForm.show.value='Welcome to Microsoft
 .NET'}<"
           scriptString += "/"
           scriptString += "script>"
           RegisterClientScriptBlock("clientScript",
 scriptString)
         End If
         
       End Sub
     </script>
  </head>
  <body topmargin="20" leftmargin="10">
     <form id="myForm" runat="server">
        <input type="text" id="show"
 style="width=200">
      <input type="button" value="ClickMe"
 onclick="DoClick()">
     </form>
  </body>
</html>

<html>
  <head>
    <script language="C#" runat="server">

      public void Page_Load(Object sender,
 EventArgs e)
      {

        if (!this.IsClientScriptBlockRegistered("clientScript"))
        {
          // Form the script that is to be registered at client side.
          String scriptString = "<script language=JavaScript> function
 DoClick() {";
          scriptString += "myForm.show.value='Welcome to Microsoft .NET'}<";
          scriptString += "/";
          scriptString += "script>";
          this.RegisterClientScriptBlock("clientScript",
 scriptString);
        }
      }

     </script>
  </head>
  <body topmargin="20" leftmargin="10">
     <form id="myForm" runat="server">
        <input type="text" id="show" style="width=200">
 <input type="button" value="ClickMe" onclick="DoClick()">
     </form>
  </body>
</html>

<html>
    <head>
        <script language="VJ#" runat="server">

          public void Page_Load(Object sender,
 EventArgs e)
          {
            if (!(this.IsClientScriptBlockRegistered("clientScript")))
 
            {
              // Form the script that is to be registered at client
 side.
              String scriptString = 
                "<script language=JavaScript> function DoClick() {";
              scriptString += "myForm.show.value='Welcome to Microsoft .NET'}<";
              scriptString += "/";
              scriptString += "script>";
              this.RegisterClientScriptBlock("clientScript",
 scriptString);
            }
        }//Page_Load
        </script>
    </head>
  <body topmargin="20" leftmargin="10">
     <form id="myForm" runat="server">
        <input type="text" id="show" style="width=200">
 <input type="button" value="ClickMe" onclick="DoClick()">
     </form>
  </body>
</html>