ScriptManager::RegisterClientScriptBlock Method (Page^, Type^, String^, String^, Boolean)

 

Registers a client script block with the ScriptManager control for use with a control that is inside an UpdatePanel control, and then adds the script block to the page.

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

public:
static void RegisterClientScriptBlock(
	Page^ page,
	Type^ type,
	String^ key,
	String^ script,
	bool addScriptTags
)

Parameters

page
Type: System.Web.UI::Page^

The page object that is registering the client script block.

type
Type: System::Type^

The type of the client script block. This parameter is usually specified by using the typeof operator (C#) or the GetType operator (Visual Basic) to retrieve the type of the control that is registering the script.

key
Type: System::String^

A unique identifier for the script block.

script
Type: System::String^

The script to register.

addScriptTags
Type: System::Boolean

true to enclose the script block in <script> and </script> tags; otherwise, false.

Exception Condition
ArgumentNullException

The script block type is null.

- or -

The page that is registering the script block is null.

When you register a script block by using this method, the script is rendered every time that an asynchronous postback occurs. To register a script block for a control that is inside an UpdatePanel control so that script is registered only when the UpdatePanel control is updated, use the RegisterClientScriptBlock(Control^, Type^, String^, String^, Boolean) overload of this method.

If you want to register a script block that does not pertain to partial-page updates, and if you want to register the script block only one time during initial page rendering, use the RegisterClientScriptBlock method of the ClientScriptManager class. You can get a reference to the ClientScriptManager object from the ClientScript property of the page.

.NET Framework
Available since 3.5
Return to top
Show: