Share via

ClientScriptManager.RegisterOnSubmitStatement(Type, String, String) Método

  • Referência

Definição

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

Registra a instrução OnSubmit com o objeto Page usando um tipo, uma chave e um literal de script. A instrução é executada quando o HtmlForm é enviado.

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)

Parâmetros

type
Type

O tipo da instrução OnSubmit a ser registrada.

key
String

A chave da instrução OnSubmit a ser registrada.

script
String

O literal de script da instrução OnSubmit a ser registrada.

Exceções

ArgumentNullException

type é null.

Exemplos

O exemplo de código a seguir demonstra o uso do RegisterOnSubmitStatement método .

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

Comentários

Uma instrução OnSubmit é identificada exclusivamente por sua chave e seu tipo. Instruções com a mesma chave e tipo são consideradas duplicatas. Somente uma instrução com um determinado tipo e par de chaves pode ser registrada com a página. Tentar registrar uma instrução que já está registrada não criará uma duplicata da instrução.

Chame o IsOnSubmitStatementRegistered método para determinar se uma instrução OnSubmit já está registrada com uma determinada chave e um par de tipos e evite tentar adicionar o script desnecessariamente.

O script parâmetro do RegisterOnSubmitStatement método pode conter vários comandos de script, desde que sejam delimitados corretamente com um ponto e vírgula (;).

O RegisterOnSubmitStatement adiciona um script que é executado antes que a página seja enviada e oferece a oportunidade de cancelar o envio.

Para obter mais informações sobre formulários HTML e o OnSubmit atributo, consulte o site W3C (World Wide Web Consortium).

Aplica-se a

Confira também