ScriptManager.RegisterStartupScript Method (Page, Type, String, String, Boolean) (System.Web.UI)

RegisterStartupScript Method (Page,...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.Net Framework 3.5

Other versions are also available for the following:

Microsoft Visual Studio 2010/.NET Framework 4.0

.NET Framework Class Library

ScriptManager..::.RegisterStartupScript Method (Page, Type, String, String, Boolean)

Registers a startup script block for every asynchronous postback with the ScriptManager control and 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 RegisterStartupScript ( _
    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.RegisterStartupScript(page, _
    type, key, script, addScriptTags)

public static void RegisterStartupScript(
    Page page,
    Type type,
    string key,
    string script,
    bool addScriptTags
)

Visual C++

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

JScript

public static function RegisterStartupScript(
    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 with <script> and </script> tags; otherwise, false.

Remarks

You use this method to register a startup script block that is included every time that an asynchronous postback occurs. To register a script block for a control that is inside an UpdatePanel control so that the script block is registered only when the UpdatePanel control is updated, use the RegisterStartupScript(Control, Type, String, String, Boolean) overload of this method.

If you want to register a startup script that does not pertain to partial-page updates, and if you want to register the script only one time during initial page rendering, use the RegisterStartupScript 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

Reference

ScriptManager Class

ScriptManager Members

RegisterStartupScript Overload

System.Web.UI Namespace

RegisterStartupScript