Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ScriptManager.RegisterOnSubmitStatement Method (Control, Type, String, String)

Registers ECMAScript (JavaScript) code with the ScriptManager control for a control that is used with an UpdatePanel control that is executed when the form is submitted.

Namespace:  System.Web.UI
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
public static void RegisterOnSubmitStatement(
	Control control,
	Type type,
	string key,
	string script
)

Parameters

control
Type: System.Web.UI.Control

The control that is registering the onsubmit statement.

type
Type: System.Type

The type of the client script statement. 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 statement.

script
Type: System.String

The script to register.

ExceptionCondition
ArgumentNullException

control is null.

- or -

type is null.

ArgumentException

control is not in the page's control tree.

The RegisterOnSubmitStatement adds script that is executed before the form is submitted, which lets you modify the submission or cancel it.

You use the RegisterOnSubmitStatement method to render an onsubmit statement that is compatible with partial-page rendering and that has no Microsoft Ajax Library dependencies. JavaScript code that is registered by using this method is sent to the page only when the control that is registering the statement is inside an UpdatePanel control that is being updated. To register code with every asynchronous postback, use the RegisterOnSubmitStatement(Page, Type, String, String) overload of this method.

If you want to register JavaScript code that does not pertain to partial-page updates, and if you want to register the code only one time during initial page rendering, use the RegisterOnSubmitStatement method of the ClientScriptManager class. You can get a reference to the ClientScriptManager object from the ClientScript property of the page.

The script parameter of the RegisterOnSubmitStatement method can contain multiple script commands that are delimited by using semicolons (;).

For more information about HTML forms and the onsubmit event, see the World Wide Web Consortium (W3C) Web site.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.