Page.RegisterOnSubmitStatement(String, String) Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

The recommended alternative is ClientScript.RegisterOnSubmitStatement(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202

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

public:
 void RegisterOnSubmitStatement(System::String ^ key, System::String ^ script);

public void RegisterOnSubmitStatement (string key, string script);

[System.Obsolete("The recommended alternative is ClientScript.RegisterOnSubmitStatement(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")]
public void RegisterOnSubmitStatement (string key, string script);

member this.RegisterOnSubmitStatement : string * string -> unit

[<System.Obsolete("The recommended alternative is ClientScript.RegisterOnSubmitStatement(Type type, string key, string script). http://go.microsoft.com/fwlink/?linkid=14202")>]
member this.RegisterOnSubmitStatement : string * string -> unit

Public Sub RegisterOnSubmitStatement (key As String, script As String)

Parameters

key: String

Unique key that identifies a script block.

script: String

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

Attributes: ObsoleteAttribute

Examples

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.

Important

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);
}


     Dim scriptString As String = "<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)

Remarks

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

Applies to

Share via