Page.RegisterClientScriptBlock Method (String, String)
Emits client-side script blocks to the response.
Assembly: System.Web (in System.Web.dll)
<ObsoleteAttribute("The recommended alternative is ClientScript.RegisterClientScriptBlock(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")> Public Overridable Sub RegisterClientScriptBlock ( key As String, script As String )
Parameters
- key
-
Type:
System.String
Unique key that identifies a script block.
- script
-
Type:
System.String
Content of script that is sent to the client.
The client-side script is emitted just after the opening tag of the Page object's <form runat= server> element. Be sure to include opening and closing <script> elements around the script block string specified in the script parameter.
Because this method uses a key to identify the script block, the script block does not have to be emitted to the output stream each time it is requested by a different server control instance. Using a key also decreases the likelihood of different controls' script blocks interfering with each other.
Any script blocks with the same key parameter values are considered duplicates.
Note |
|---|
Remember to include HTML comment tags around your script so that it will not be rendered if the requesting browser does not support scripts. |
The RegisterClientScriptBlock method has been deprecated. Use the RegisterClientScriptBlock method in the ClientScriptManager class instead.
The following code example demonstrates the use of the RegisterClientScriptBlock method in conjunction with the IsClientScriptBlockRegistered method. If the ECMAScript in the code declaration block has not already been registered, as determined by IsClientScriptBlockRegistered, the RegisterClientScriptBlock 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>
Available since 1.1
