ScriptManager.RegisterOnSubmitStatement Method

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.Extensions.dll

Registers ECMAScript (JavaScript) code that is executed when the form is submitted.

Overloads

RegisterOnSubmitStatement(Page, 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.
RegisterOnSubmitStatement(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.

RegisterOnSubmitStatement(Page, 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.

public:
 static void RegisterOnSubmitStatement(System::Web::UI::Page ^ page, Type ^ type, System::String ^ key, System::String ^ script);
public static void RegisterOnSubmitStatement (System.Web.UI.Page page, Type type, string key, string script);
static member RegisterOnSubmitStatement : System.Web.UI.Page * Type * string * string -> unit
Public Shared Sub RegisterOnSubmitStatement (page As Page, type As Type, key As String, script As String)

Parameters

page
Page

The page object that is registering the onsubmit statement.

type
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
String

A unique identifier for the script statement.

script
String

The script to register.

Exceptions

ArgumentNullException

page is null.

-or-

type is null.

Remarks

Registering JavaScript code with this method causes the script to be included every time that an asynchronous postback occurs.

Note

Code from any earlier asynchronous postbacks is not removed. New asynchronous postbacks append code to any existing code for the onsubmit statement.

To register code for a control that is inside an UpdatePanel control so that the code is registered only when the UpdatePanel control is updated, use the RegisterOnSubmitStatement(Control, 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.

See also

Applies to

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

public:
 static void RegisterOnSubmitStatement(System::Web::UI::Control ^ control, Type ^ type, System::String ^ key, System::String ^ script);
public static void RegisterOnSubmitStatement (System.Web.UI.Control control, Type type, string key, string script);
static member RegisterOnSubmitStatement : System.Web.UI.Control * Type * string * string -> unit
Public Shared Sub RegisterOnSubmitStatement (control As Control, type As Type, key As String, script As String)

Parameters

control
Control

The control that is registering the onsubmit statement.

type
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
String

A unique identifier for the script statement.

script
String

The script to register.

Exceptions

ArgumentNullException

control is null.

-or-

type is null.

ArgumentException

control is not in the page's control tree.

Remarks

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.

See also

Applies to