ClientScriptManager.RegisterOnSubmitStatement(Type, String, String) Methode

  • Referenz

Definition

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

Registriert unter Verwendung eines Typs, eines Schlüssels sowie eines Skriptliterals eine OnSubmit-Anweisung für das Page-Objekt. Die Anweisung wird beim Übermitteln des HtmlForm ausgeführt.

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)

Parameter

type
Type

Der Typ der zu registrierenden OnSubmit-Anweisung.

key
String

Der Schlüssel der zu registrierenden OnSubmit-Anweisung.

script
String

Das Skriptliteral der zu registrierenden OnSubmit-Anweisung.

Ausnahmen

ArgumentNullException

type ist null.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterOnSubmitStatement -Methode veranschaulicht.

<%@ 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>

Hinweise

Eine OnSubmit-Anweisung wird durch ihren Schlüssel und ihren Typ eindeutig identifiziert. Anweisungen mit demselben Schlüssel und Typ gelten als Duplikate. Nur eine Anweisung mit einem bestimmten Typ- und Schlüsselpaar kann bei der Seite registriert werden. Beim Versuch, eine bereits registrierte Anweisung zu registrieren, wird kein Duplikat der Anweisung erstellt.

Rufen Sie die IsOnSubmitStatementRegistered -Methode auf, um festzustellen, ob eine OnSubmit-Anweisung bereits mit einem bestimmten Schlüssel- und Typpaar registriert ist, und vermeiden Sie unnötigen Versuch, das Skript hinzuzufügen.

Der script Parameter der RegisterOnSubmitStatement -Methode kann mehrere Skriptbefehle enthalten, solange sie ordnungsgemäß durch ein Semikolon (;)) getrennt sind.

Die RegisterOnSubmitStatement fügt ein Skript hinzu, das ausgeführt wird, bevor die Seite übermittelt wird, und gibt Ihnen die Möglichkeit, die Übermittlung abzubrechen.

Weitere Informationen zu HTML-Formularen und dem OnSubmit -Attribut finden Sie auf der W3C-Website (World Wide Web Consortium).

Gilt für:

Weitere Informationen