Actualización: noviembre 2007
Registra una instrucción OnSubmit con el objeto Page utilizando un tipo, una clave y un literal de script. La instrucción se ejecuta cuando se envía el objeto HtmlForm.
(en System.Web.dll)
Visual Basic (Declaración)
Public Sub RegisterOnSubmitStatement ( _
type As Type, _
key As String, _
script As String _
)
Dim instance As ClientScriptManager
Dim type As Type
Dim key As String
Dim script As String
instance.RegisterOnSubmitStatement(type, _
key, script)
public void RegisterOnSubmitStatement(
Type type,
string key,
string script
)
public:
void RegisterOnSubmitStatement(
Type^ type,
String^ key,
String^ script
)
public void RegisterOnSubmitStatement(
Type type,
String key,
String script
)
public function RegisterOnSubmitStatement(
type : Type,
key : String,
script : String
)
Parámetros
- type
- Tipo: System..::.Type
Tipo de la instrucción OnSubmit que se va a registrar.
- key
- Tipo: System..::.String
Clave de la instrucción OnSubmit que se va a registrar.
- script
- Tipo: System..::.String
Literal de script de la instrucción OnSubmit que se va a registrar.
| Excepción | Condición |
|---|
| ArgumentNullException |
El valor de type es nullNothingnullptrreferencia null (Nothing en Visual Basic).
|
Una instrucción OnSubmit se identifica de forma única mediante su clave y su tipo. Las instrucciones de la misma clave y tipo se consideran duplicadas. Sólo se puede registrar una instrucción con un par de clave y tipo específicos con la página. Al intentar registrar una instrucción que ya está registrada no se creará un duplicado de ella.
Llame al método IsOnSubmitStatementRegistered para determinar si una instrucción OnSubmit ya está registrada con un par de clave y tipo específicos, y evitar innecesariamente agregar el script.
El parámetro script del método RegisterOnSubmitStatement puede contener varios comandos de script siempre y cuando se delimiten correctamente con un punto y coma (;).
El método RegisterOnSubmitStatement agrega un script que se ejecuta antes de enviar la página y le da una oportunidad de cancelar el envío.
Para obtener más información sobre los formularios HTML y el atributo OnSubmit, visite sitio Web de World Wide Web Consortium (W3C).
En el ejemplo de código siguiente se muestra el uso del método RegisterOnSubmitStatement.
<%@ 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 >
<head>
<title>ClientScriptManager Example</title>
</head>
<body>
<form id="Form1"
runat="server">
<input type="submit"
value="Submit" />
</form>
</body>
</html>
<%@ 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 >
<head>
<title>ClientScriptManager Example</title>
</head>
<body>
<form id="Form1"
runat="server">
<input type="submit"
value="Submit" />
</form>
</body>
</html>
Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.
.NET Framework
Compatible con: 3.5, 3.0, 2.0
Referencia