This documentation is archived and is not being maintained.

Page.RegisterOnSubmitStatement Method

NOTE: This API is now obsolete.

Allows a page to access the client OnSubmit event. The script should be a function call to client code registered elsewhere.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

[ObsoleteAttribute("The recommended alternative is ClientScript.RegisterOnSubmitStatement(Type type, string key, string script).")]
public void RegisterOnSubmitStatement(
	string key,
	string script


Type: System.String

Unique key that identifies a script block.

Type: System.String

The client-side script to be sent to the client.

The RegisterOnSubmitStatement method has been deprecated. Use the RegisterOnSubmitStatement method in the ClientScriptManager class.

The following code example demonstrates using the RegisterOnSubmitStatement to access a script that responds when a client-side Submit button is clicked. When this event occurs, the registered ECMAScript code is executed on the client.

Security noteSecurity Note:

This example has a hidden field, which is a potential security threat. By default, you should validate the value of a hidden field as you would the value of a text box. ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

void Page_Load(Object sender, EventArgs e) 
   String scriptString = "<script language=\"JavaScript\"> function doClick() {";
   scriptString += "document.write('<h4>' + myForm.myHiddenField.value+ '</h4>');}<";
   scriptString += "/" + "script>";

   RegisterHiddenField("myHiddenField", "Welcome to Microsoft!"); 

   RegisterOnSubmitStatement("submit", "document.write('<h4>Submit button clicked.</h4>')"); 

   RegisterStartupScript("startup", scriptString);

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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.

.NET Framework

Supported in: 1.1, 1.0
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2