Page.IsStartupScriptRegistered Method
Note: This API is now obsolete.
Determines whether the client startup script is registered with the Page object.
Assembly: System.Web (in System.Web.dll)
'Declaration <ObsoleteAttribute("The recommended alternative is ClientScript.IsStartupScriptRegistered(string key). http://go.microsoft.com/fwlink/?linkid=14202")> _ Public Function IsStartupScriptRegistered ( _ key As String _ ) As Boolean
Parameters
- key
- Type: System.String
The string key of the startup script to search for.
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.
<%@ 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 EventArgs) Dim csname1 As String = "PopupScript" Dim csname2 As String = "ButtonClickScript" If Not IsClientScriptBlockRegistered(csname1) Then Dim cstext1 As String = "<script type=""text/javascript"">" & _ "alert('Hello World');</" & "script>" RegisterStartupScript(csname1, cstext1) End If If Not IsClientScriptBlockRegistered(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>") RegisterClientScriptBlock(csname2, cstext2.ToString()) End If End Sub </script> <html > <head> <title>RegisterClientScriptBlock Example</title> </head> <body> <form id="Form1" runat="server"> <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" /> </form> </body> </html>
.NET Framework
Supported in: 1.1, 1.0Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.