Export (0) Print
Expand All
Expand Minimize

Page.IsStartupScriptRegistered Method

NOTE: This method is now obsolete.

Determines whether the client startup script is registered with the Page object.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

[ObsoleteAttribute("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
)
ObsoleteAttribute("The recommended alternative is ClientScript.IsStartupScriptRegistered(string key). http://go.microsoft.com/fwlink/?linkid=14202") 
public function IsStartupScriptRegistered (
	key : String
) : boolean
Not applicable.

Parameters

key

The string key of the startup script to search for.

Return Value

true if the startup script is registered; otherwise, false.

Call this method before calling Page.RegisterStartupScript to avoid unnecessarily assembling the client-side script. This is particularly important if the script requires a large amount of server resources to create.

The IsStartupScriptRegistered method has been deprecated. Use the IsStartupScriptRegistered method in the ClientScriptManager class.

The following code example demonstrates the use of the RegisterStartupScript method in conjunction with the IsStartupScriptRegistered method. If the ECMAScript written in the code declaration block has not already been registered, as determined by IsStartupScriptRegistered, then a RegisterStartupScript call is made.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>Welcome to Microsoft .NET!</title>
<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 style="margin-top:20; margin-left: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>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
    <title>Welcome" 
                + " to Microsoft .NET!</title>
<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 style="margin-top:20; margin-left: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>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 1.0, 1.1, 2.0
Obsolete (compiler warning) in 3.0

Community Additions

ADD
Show:
© 2014 Microsoft