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

Definição

Espaço de Nomes:
System.Web.UI
Assemblagem:
System.Web.dll

Regista uma instrução OnSubmit com o Page objeto usando um tipo, uma chave e um script literal. A instrução executa-se quando o HtmlForm é submetido.

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 declaração OnSubmit para registar.

key
String

A chave do extrato OnSubmit para registar.

script
String

O script literal da instrução OnSubmit para registar.

Exceções

ArgumentNullException

type é null.

Exemplos

O exemplo de código seguinte demonstra a utilização 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>

Observações

Uma instrução OnSubmit é identificada de forma única pela sua chave e pelo seu tipo. Instruções com a mesma chave e tipo são consideradas duplicadas. Apenas uma instrução com um dado tipo e par de chaves pode ser registada na página. Tentar registar um extrato já registado não criará um duplicado do extrato.

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

O script parâmetro do RegisterOnSubmitStatement método pode conter múltiplos comandos de script desde que estejam devidamente delimitados com um ponto e vírgula (;).

Adiciona RegisterOnSubmitStatement um script que é executado antes da página ser submetida e dá-te a oportunidade de cancelar a submissão.

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

Aplica-se a

Ver também