ClientScriptManager::RegisterClientScriptBlock Method (Type^, String^, String^)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Registers the client script with the Page object using a type, key, and script literal.

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

void RegisterClientScriptBlock(
	Type^ type,
	String^ key,
	String^ script


Type: System::Type^

The type of the client script to register.

Type: System::String^

The key of the client script to register.

Type: System::String^

The client script literal to register.

A client script is uniquely identified by its key and its type. Scripts with the same key and type are considered duplicates. Only one script with a given type and key pair can be registered with the page. Attempting to register a script that is already registered does not create a duplicate of the script.

Call the IsClientScriptBlockRegistered method to determine whether a client script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

In this overload of the RegisterClientScriptBlock method, you must make sure that the script provided in the script parameter is wrapped in a <script> element block.

The RegisterClientScriptBlock method adds a script block to the top of the rendered page. The script blocks are not guaranteed to be output in the order they are registered. If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

The following code example demonstrates the use of the RegisterClientScriptBlock method.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top