ClientScriptManager.RegisterClientScriptBlock Method (Type, String, String) (System.Web.UI)

Microsoft Developer Network

RegisterClientScriptBlock Method (Type, String,...

.NET Framework Class Library

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

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)

Syntax

Visual Basic (Declaration)

Public Sub RegisterClientScriptBlock ( _
    type As Type, _
    key As String, _
    script As String _
)

Visual Basic (Usage)

Dim instance As ClientScriptManager
Dim type As Type
Dim key As String
Dim script As String

instance.RegisterClientScriptBlock(type, _
    key, script)

public void RegisterClientScriptBlock(
    Type type,
    string key,
    string script
)

Visual C++

public:
void RegisterClientScriptBlock(
    Type^ type, 
    String^ key, 
    String^ script
)

JScript

public function RegisterClientScriptBlock(
    type : Type, 
    key : String, 
    script : String
)

Parameters

type: Type: System..::.Type
The type of the client script to register.

key: Type: System..::.String
The key of the client script to register.

script: Type: System..::.String
The client script literal to register.

Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

ClientScriptManager Class

ClientScriptManager Members

RegisterClientScriptBlock Overload

System.Web.UI Namespace

RegisterClientScriptBlock