.NET Framework Class Library
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)
Syntax

Visual Basic (Declaration)
Public Shared Sub RegisterClientScriptBlock ( _
    page As Page, _
    type As Type, _
    key As String, _
    script As String, _
    addScriptTags As Boolean _
)
Visual Basic (Usage)
Dim page As Page
Dim type As Type
Dim key As String
Dim script As String
Dim addScriptTags As Boolean

ScriptManager.RegisterClientScriptBlock(page, _
    type, key, script, addScriptTags)
C#
public static void RegisterClientScriptBlock(
    Page page,
    Type type,
    string key,
    string script,
    bool addScriptTags
)
Visual C++
public:
static void RegisterClientScriptBlock(
    Page^ page, 
    Type^ type, 
    String^ key, 
    String^ script, 
    bool addScriptTags
)
JScript
public static function RegisterClientScriptBlock(
    page : Page, 
    type : Type, 
    key : String, 
    script : String, 
    addScriptTags : boolean
)

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.
addScriptTags
Type: System..::.Boolean
true to enclose the script block in <script> and </script> tags; otherwise, false.
Exceptions

ExceptionCondition
ArgumentNullException

The script block type is nullNothingnullptra null reference (Nothing in Visual Basic).

- or -

The page that is registering the script block is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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
See Also

Reference

Tags :


Page view tracker