ClientScriptManager.RegisterOnSubmitStatement(Type, String, String) Metod

Definition

Namnområde:
System.Web.UI
Sammansättning:
System.Web.dll

Registrerar en OnSubmit-instruktion med objektet med Page hjälp av en typ, en nyckel och en skriptliteral. -instruktionen körs när den HtmlForm skickas.

public:
 void RegisterOnSubmitStatement(Type ^ type, System::String ^ key, System::String ^ script);
public void RegisterOnSubmitStatement(Type type, string key, string script);
member this.RegisterOnSubmitStatement : Type * string * string -> unit
Public Sub RegisterOnSubmitStatement (type As Type, key As String, script As String)

Parametrar

type
Type

Typen av OnSubmit-instruktion som ska registreras.

key
String

Nyckeln för onSubmit-instruktionen som ska registreras.

script
String

Skriptliteralen för OnSubmit-instruktionen som ska registreras.

Undantag

ArgumentNullException

type är null.

Exempel

I följande kodexempel visas hur metoden används RegisterOnSubmitStatement .

<%@ Page Language="C#"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  public void Page_Load(Object sender, EventArgs e)
  {
    // Define the name and type of the client script on the page.
    String csname = "OnSubmitScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the OnSubmit statement is already registered.
    if (!cs.IsOnSubmitStatementRegistered(cstype, csname))
    {
      String cstext = "document.write('Text from OnSubmit statement');";
      cs.RegisterOnSubmitStatement(cstype, csname, cstext);
    }

  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="submit"
            value="Submit" />
     </form>
  </body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    ' Define the name and type of the client script on the page.
    Dim csname As String = "OnSubmitScript"
    Dim cstype As Type = Me.GetType()
    
    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript
    
    ' Check to see if the OnSubmit statement is already registered.
    If (Not cs.IsOnSubmitStatementRegistered(cstype, csname)) Then
      
      Dim cstext As String = "document.write('Text from OnSubmit statement.');"
      cs.RegisterOnSubmitStatement(cstype, csname, cstext)
      
    End If
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="submit"
            value="Submit" />
     </form>
  </body>
</html>

Kommentarer

En OnSubmit-instruktion identifieras unikt av dess nyckel och dess typ. Instruktioner med samma nyckel och typ betraktas som dubbletter. Endast en instruktion med en viss typ och ett nyckelpar kan registreras på sidan. Försök att registrera en -instruktion som redan är registrerad skapar inte en dubblett av -instruktionen.

IsOnSubmitStatementRegistered Anropa metoden för att avgöra om en OnSubmit-instruktion redan är registrerad med en viss nyckel och typpar och undvik onödigt försök att lägga till skriptet.

Parametern script för RegisterOnSubmitStatement metoden kan innehålla flera skriptkommandon så länge de är korrekt avgränsade med ett semikolon (;).

RegisterOnSubmitStatement Lägger till ett skript som körs innan sidan skickas och ger dig möjlighet att avbryta sändningen.

Mer information om HTML-formulär och OnSubmit attributet finns på W3C-webbplatsen (World Wide Web Consortium).

Gäller för

Se även