Export (0) Print
Expand All
Expand Minimize

Page.IsClientScriptBlockRegistered Method

NOTE: This method is now obsolete.

Determines whether the client script block with the specified key is registered with the page.

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

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

Parameters

key

The string key of the client script to search for.

Return Value

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

Call this method before calling Page.RegisterClientScriptBlock 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 IsClientScriptBlockRegistered method has been deprecated. Use the IsClientScriptBlockRegistered method in the ClientScriptManager class.

The following code example demonstrates the use of the RegisterClientScriptBlock method in conjunction with the IsClientScriptBlockRegistered method. If the ECMAScript written in the code declaration block has not already been registered, as determined by IsClientScriptBlockRegistered, then a RegisterClientScriptBlock 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>ASP.NET Example</title>
<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 style="margin-top:20; margin-left:10">
     <form id="myForm" runat="server">
        <input type="text" id="show" style="width:200" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </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>ASP.NET Example</title>
<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 style="margin-top:20; margin-left:10">
     <form id="myForm" runat="server">
        <input type="text" id="show" style="width:200" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </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:
© 2015 Microsoft