Page.RegisterClientScriptBlock Method
NOTE: This method is now obsolete.
Emits client-side script blocks to the response. Namespace: System.Web.UIAssembly: System.Web (in system.web.dll)
'Declaration <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 _ ) 'Usage Dim instance As Page Dim key As String Dim script As String instance.RegisterClientScriptBlock(key, script)
/** @attribute ObsoleteAttribute("The recommended alternative is ClientScript.RegisterClientScriptBlock(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202") */
public void RegisterClientScriptBlock (
String key,
String script
)
ObsoleteAttribute("The recommended alternative is ClientScript.RegisterClientScriptBlock(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202") public function RegisterClientScriptBlock ( key : String, script : String )
Not applicable.
Parameters
- key
Unique key that identifies a script block.
- script
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 a 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.
<!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="VB" runat="server"> Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) If (Not IsClientScriptBlockRegistered("clientScript")) Then 'Form the script that is to be registered at client side. Dim scriptString As String = "<script language=""JavaScript""> function DoClick() {" scriptString += "myForm.show.value='Welcome to Microsoft .NET'}<" scriptString += "/" scriptString += "script>" RegisterClientScriptBlock("clientScript", scriptString) End If End Sub </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>
Note: