ScriptManager.RegisterStartupScript Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.Extensions.dll

Registers a startup script block with the ScriptManager control and adds the script block to the page.

Overloads

RegisterStartupScript(Control, Type, String, String, Boolean)	Registers a startup script block for a control that is inside an UpdatePanel by using the ScriptManager control, and adds the script block to the page.
RegisterStartupScript(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.

RegisterStartupScript(Control, Type, String, String, Boolean)

Registers a startup script block for a control that is inside an UpdatePanel by using the ScriptManager control, and adds the script block to the page.

public:
 static void RegisterStartupScript(System::Web::UI::Control ^ control, Type ^ type, System::String ^ key, System::String ^ script, bool addScriptTags);

public static void RegisterStartupScript (System.Web.UI.Control control, Type type, string key, string script, bool addScriptTags);

static member RegisterStartupScript : System.Web.UI.Control * Type * string * string * bool -> unit

Public Shared Sub RegisterStartupScript (control As Control, type As Type, key As String, script As String, addScriptTags As Boolean)

Parameters

control

Control

The control that is registering the client script block.

type

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

String

A unique identifier for the script block.

script

String

The script to register.

addScriptTags

Boolean

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

Exceptions

ArgumentNullException

control is null.

-or-

type is null.

ArgumentException

control is not in the page's control tree.

Remarks

You use the RegisterStartupScript method to register a startup script block for a page that is compatible with partial-page rendering and that has no Microsoft Ajax Library dependencies. Startup script blocks that are registered by using this method are sent to the page only when the control that is registering the block is inside an UpdatePanel control that is being updated. To register a startup script block every time that an asynchronous postback occurs, use the RegisterStartupScript(Page, 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.

The script block that is rendered by the RegisterStartupScript method executes when the page finishes loading but before the page's client onload event is raised. Startup script blocks are located at the bottom of the rendered ASP.NET page just before the </form> tag.

Startup script blocks that are registered by using RegisterStartupScript are not guaranteed to be output in the same order in which they are registered. If the order of the startup script blocks is important, use a StringBuilder object to gather the script blocks in a single string, and then register them all as a single startup script.

See also

• RegisterStartupScript(Page, Type, String, String, Boolean)

RegisterStartupScript(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.

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

public static void RegisterStartupScript (System.Web.UI.Page page, Type type, string key, string script, bool addScriptTags);

static member RegisterStartupScript : System.Web.UI.Page * Type * string * string * bool -> unit

Public Shared Sub RegisterStartupScript (page As Page, type As Type, key As String, script As String, addScriptTags As Boolean)

Parameters

page

Page

The page object that is registering the client script block.

type

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

String

A unique identifier for the script block.

script

String

The script to register.

addScriptTags

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.

See also

• RegisterStartupScript(Control, Type, String, String, Boolean)