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

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

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

Page.IsStartupScriptRegistered メソッド

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

returnValue = instance.IsStartupScriptRegistered(key)

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

C++

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

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

JScript

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

パラメータ

key: 検索対象の起動スクリプトの文字列キー。

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

解説

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

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

使用例

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

Visual Basic

<html>
  <head>
     <script language="VB" runat="server">
       Public Sub Page_Load(ByVal
 Sender As Object, ByVal
 e As EventArgs)
         If (Not Me.IsStartupScriptRegistered("Startup"))
 Then
           ' Form the script to be registered at client side.
           Dim scriptString As String
 = "<script language=JavaScript> function DoClick() {"
           scriptString += "showMessage2.innerHTML='<h4>Welcome
 to Microsoft .NET!</h4>'}"
           scriptString += "function Page_Load(){ showMessage1.innerHTML="
           scriptString += "'<h4>RegisterStartupScript Example</h4>'}<"
           scriptString += "/"
           scriptString += "script>"
           Me.RegisterStartupScript("Startup",
 scriptString)
         End If
       End Sub
        </script>
  </head>
  <body topmargin="20" leftmargin="10"
 onload="Page_Load()">
     <form id="myForm" runat="server">
        <span id="showMessage1"></span>
        <br>
        <input type="button" value="ClickMe"
 onclick="DoClick()">
        <br>
        <span id="showMessage2"></span>
     </form>
  </body>
</html>

<html>
  <head>
    <script language="C#" runat="server">
      public void Page_Load(Object sender,
 EventArgs e)
      {

        if (!this.IsStartupScriptRegistered("Startup"))
        {
          // Form the script to be registered at client side.
          String scriptString = "<script language=JavaScript> function
 DoClick() {";
          scriptString += "showMessage2.innerHTML='<h4>Welcome to Microsoft
 .NET!</h4>'}";
          scriptString += "function Page_Load(){ showMessage1.innerHTML=";
          scriptString += "'<h4>RegisterStartupScript Example</h4>'}<";
          scriptString += "/";
          scriptString += "script>";
          this.RegisterStartupScript("Startup", scriptString);
        }
      }
     </script>
  </head>
  <body topmargin="20" leftmargin="10" onload="Page_Load()">
     <form id="myForm" runat="server">
        <span id="showMessage1"></span>
        <br>
        <input type="button" value="ClickMe" onclick="DoClick()">
        <br>
        <span id="showMessage2"></span>
     </form>
  </body>
</html>

<html>
    <head>
        <script language="VJ#" runat="server">
          public void Page_Load(Object sender,
 EventArgs e)
          {

            if (!(this.IsStartupScriptRegistered("Startup")))
            {
              // Form the script to be registered at client side.
              String scriptString = "<script language=JavaScript> function
 DoClick() {";
              scriptString += "showMessage2.innerHTML='<h4>Welcome"
 
                + " to Microsoft .NET!</h4>'}";
              scriptString += "function Page_Load(){ showMessage1.innerHTML=";
              scriptString += "'<h4>RegisterStartupScript Example</h4>'}<";
              scriptString += "/";
              scriptString += "script>";
              this.RegisterStartupScript("Startup",
 scriptString);
            }
          } 
        </script>
    </head>
    <body topmargin="20" leftmargin="10" onload="Page_Load()">
        <form id="myForm" runat="server">
            <span id="showMessage1"></span>
            <br>
            <input type="button" value="ClickMe" onclick="DoClick()">
            <br>
            <span id="showMessage2"></span>
        </form>
    </body>
</html>