Documentation for: ASP.NET Ajax Version 1.0

This documentation is for a previous version. For the current released version, see the ASP.NET Ajax documentation on MSDN.

 

 

 

 

 

 

 

Skip Navigation Links.
ScriptManager Class
ScriptManager Constructor
AllowCustomErrorsRedirect Property
AsyncPostBackError Event
AsyncPostBackErrorMessage Property
AsyncPostBackSourceElementID Property
AsyncPostBackTimeout Property
AuthenticationService Property
EnablePageMethods Property
EnablePartialRendering Property
EnableScriptGlobalization Property
EnableScriptLocalization Property
GetCurrent Method (page)
IsDebuggingEnabled Property
IsInAsyncPostBack Property
LoadPostData Method (postDataKey, postCollection)
LoadScriptsBeforeUI Property
OnAsyncPostBackError Method (e)
OnInit Method (e)
OnPreRender Method (e)
OnResolveScriptReference Method (e)
ProfileService Property
RaisePostDataChangedEvent Method
RegisterArrayDeclaration Method
RegisterArrayDeclaration Method (control, arrayName, arrayValue)
RegisterArrayDeclaration Method (page, arrayName, arrayValue)
RegisterAsyncPostBackControl Method (control)
RegisterClientScriptBlock Method
RegisterClientScriptBlock Method (control, type, key, script, addScriptTags)
RegisterClientScriptBlock Method (page, type, key, script, addScriptTags)
RegisterClientScriptInclude Method
RegisterClientScriptInclude Method (control, type, key, url)
RegisterClientScriptInclude Method (page, type, key, url)
RegisterClientScriptResource Method
RegisterClientScriptResource Method (control, type, resourceName)
RegisterClientScriptResource Method (page, type, resourceName)
RegisterDataItem Method
RegisterDataItem Method (control, dataItem)
RegisterDataItem Method (control, dataItem, isJsonSerialized)
RegisterDispose Method (control, disposeScript)
RegisterExpandoAttribute Method (control, controlId, attributeName, attributeValue, encode)
RegisterExtenderControl Method (extenderControl, targetControl)
RegisterHiddenField Method
RegisterHiddenField Method (control, hiddenFieldName, hiddenFieldInitialValue)
RegisterHiddenField Method (page, hiddenFieldName, hiddenFieldInitialValue)
RegisterOnSubmitStatement Method
RegisterOnSubmitStatement Method (control, type, key, script)
RegisterOnSubmitStatement Method (page, type, key, script)
RegisterPostBackControl Method (control)
RegisterScriptControl Method (scriptControl)
RegisterScriptDescriptors Method
RegisterScriptDescriptors Method (extenderControl)
RegisterScriptDescriptors Method (scriptControl)
RegisterStartupScript Method
RegisterStartupScript Method (control, type, key, script, addScriptTags)
RegisterStartupScript Method (page, type, key, script, addScriptTags)
Render Method (writer)
ResolveScriptReference Event
ScriptMode Property
ScriptPath Property
Scripts Property
Services Property
SetFocus Method
SetFocus Method (clientID)
SetFocus Method (control)
SupportsPartialRendering Property
Visible Property

RegisterStartupScript Method (control, type, key, script, addScriptTags)

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.

Syntax

CSharp

public static void RegisterStartupScript (
	Control control,
	Type type,
	string key,
	string script,
	bool addScriptTags
)

VisualBasic

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

ManagedCPlusPlus

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

JSharp

public static void RegisterStartupScript (
	Control control,
	Type type,
	String key,
	String script,
	boolean addScriptTags
)

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 (C# Reference) operator (C#) or the GetType Operator operator (Visual Basic) to retrieve the type of the control that is registering the script.

key (String)

The string that uniquely identifies the script block.

script (String)

The script literal.

addScriptTags (Boolean)

A Boolean value that indicates whether to enclose the script block with <script> tags.

Remarks

The RegisterStartupScript method is used 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 with this method are sent to the page only when the control that is registering the block is inside an UpdatePanel control that is updated. To register a startup script block each time an asynchronous postback occurs, use the RegisterStartupScript(Page, Type, String, String, Boolean) overload of this method. If you are registering a script file that does not pertain to partial-page updates and you want to register a client script file only one time during initial page rendering, use the RegisterStartupScript(Type, String, String) 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 added 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 with 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.

Exceptions

ExceptionCondition
ArgumentNullException

control is null.

- or -

type is null.

ArgumentException

control is not in the page's control tree.

Assembly: System.Web.Extensions (Module: System.Web.Extensions)