ClientScriptManager Clase

Referencia

Definición

Espacio de nombres:: System.Web.UI

Ensamblado:: System.Web.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Define los métodos para la administración de scripts de cliente en aplicaciones web.

public ref class ClientScriptManager sealed

public sealed class ClientScriptManager

type ClientScriptManager = class

Public NotInheritable Class ClientScriptManager

Herencia: Object
ClientScriptManager

Ejemplos

En el ejemplo de código siguiente se muestra el uso del RegisterClientScriptBlock método de la ClientScriptManager clase . En la página se definen dos scripts de cliente: PopupScript, que muestra un mensaje de alerta cuando se carga la página y ButtonClickScript, que define un controlador de cliente para el evento de onClick un botón 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 scripts on the page.
    String csname1 = "PopupScript";
    String csname2 = "ButtonClickScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the startup script is already registered.
    if (!cs.IsStartupScriptRegistered(cstype, csname1))
    {
      String cstext1 = "alert('Hello World');";
      cs.RegisterStartupScript(cstype, csname1, cstext1, true);
    }

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(cstype, csname2))
    {
      StringBuilder cstext2 = new StringBuilder();
      cstext2.Append("<script type=\"text/javascript\"> function DoClick() {");
      cstext2.Append("Form1.Message.value='Text from client script.'} </");
      cstext2.Append("script>");
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), false);
    }
  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </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 scripts on the page.
    Dim csname1 As String = "PopupScript"
    Dim csname2 As String = "ButtonClickScript"
    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 startup script is already registered.
    If (Not cs.IsStartupScriptRegistered(cstype, csname1)) Then
      
      Dim cstext1 As String = "alert('Hello World');"
      cs.RegisterStartupScript(cstype, csname1, cstext1, True)
      
    End If
    
    ' Check to see if the client script is already registered.
    If (Not cs.IsClientScriptBlockRegistered(cstype, csname2)) Then
      
      Dim cstext2 As New StringBuilder()
            cstext2.Append("<script type=""text/javascript""> function DoClick() {")
      cstext2.Append("Form1.Message.value='Text from client script.'} </")
      cstext2.Append("script>")
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), False)
      
    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="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>

Comentarios

La ClientScriptManager clase se usa para administrar scripts de cliente y agregarlos a aplicaciones web. Puede obtener una referencia a la ClientScriptManager clase desde la ClientScript propiedad del Page objeto .

Puede agregar un script de cliente a una página web mediante declaración si incluye el script en el marcado HTML de la página. Sin embargo, hay situaciones en las que se necesita agregar un script de cliente dinámicamente. Para agregar un script dinámicamente, use el RegisterClientScriptBlock método , el RegisterClientScriptInclude método , el RegisterStartupScript método o el RegisterOnSubmitStatement método , en función de cuándo y cómo desea agregar el script. Para obtener más información, vea How to: Add Client Script Dynamically to ASP.NET Web Pages.

La ClientScriptManager clase identifica de forma única los scripts mediante una clave String y .Type Los scripts con la misma clave y tipo se consideran duplicados. El uso del tipo de script ayuda a evitar confundir scripts similares de distintos controles de usuario que podrían estar en uso en la página.

La ClientScriptManager clase se puede usar para invocar devoluciones de llamada de cliente en situaciones en las que es conveniente ejecutar código de servidor desde el cliente sin realizar un postback. Esto se conoce como realizar una devolución de llamada fuera de banda en el servidor. En una devolución de llamada de cliente, una función de script de cliente envía una solicitud asincrónica a una página web de ASP.NET. La página web ejecuta una versión modificada de su ciclo de vida normal para procesar la devolución de llamada. Use el GetCallbackEventReference método para obtener una referencia a una función de cliente que, cuando se invoca, inicia una devolución de llamada de cliente a un evento de servidor. Para obtener más información, vea Implementación de devoluciones de llamada de cliente sin postbacks.

Nota:

Las devoluciones de llamada de script no funcionarán en exploradores antiguos que no admiten el Modelo de objetos de documento (DOM) y requieren que ECMAScript esté habilitado en el cliente. Para comprobar si el explorador admite devoluciones de llamada, use la SupportsCallback propiedad , que es accesible a través de la Browser propiedad del objeto intrínseco Request ASP.NET.

Use el GetPostBackEventReference método y el GetPostBackClientHyperlink método para definir un evento de postback de cliente. Estos métodos habilitan las funciones de script de cliente, cuando se invocan, para que el servidor vuelva a publicar en la página. Un evento de postback de cliente es diferente de una devolución de llamada de cliente en que la página web completa un ciclo de vida normal para procesar el evento de postback del cliente.

Nota

Si usa un Button control y la UseSubmitBehavior propiedad se establece falseen , puede usar el GetPostBackEventReference método para devolver el evento de postback de cliente para el Button control.

La OnClientClick propiedad del control, ImageButton el control y LinkButton el Button control se pueden usar para ejecutar el script de cliente.

Métodos

Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetCallbackEventReference(Control, String, String, String)	Obtiene una referencia a una función de cliente que, cuando se invoca, inicia una devolución de llamada del cliente a un evento de servidor. La función de cliente para este método sobrecargado incluye un control, un argumento, un script de cliente y un contexto especificados.
GetCallbackEventReference(Control, String, String, String, Boolean)	Obtiene una referencia a una función de cliente que, cuando se invoca, inicia una devolución de llamada del cliente a los eventos de servidor. La función de cliente para este método sobrecargado incluye un control, un argumento, un script de cliente, un contexto y un valor booleano especificados.
GetCallbackEventReference(Control, String, String, String, String, Boolean)	Obtiene una referencia a una función de cliente que, cuando se invoca, inicia una devolución de llamada del cliente a los eventos de servidor. La función de cliente para este método sobrecargado incluye un control, un argumento, un script de cliente, un contexto, un controlador de errores y un valor booleano especificados.
GetCallbackEventReference(String, String, String, String, String, Boolean)	Obtiene una referencia a una función de cliente que, cuando se invoca, inicia una devolución de llamada del cliente a los eventos de servidor. La función de cliente para este método sobrecargado incluye un destino, un argumento, un script de cliente, un contexto, un controlador de errores y un valor booleano especificados.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetPostBackClientHyperlink(Control, String)	Obtiene una referencia, con `javascript:` anexado al principio, que se puede utilizar en un evento de devolución de datos del cliente al servidor para el control especificado y con los argumentos de evento especificados.
GetPostBackClientHyperlink(Control, String, Boolean)	Obtiene una referencia, con `javascript:` anexado al principio, que se puede utilizar en un evento de devolución de datos del cliente al servidor para el control especificado y con los argumentos de evento especificados y, también, con una indicación booleana de si se debe registrar la devolución de datos para realizar la validación del evento.
GetPostBackEventReference(Control, String)	Devuelve una cadena que se puede utilizar en un evento de cliente para que se produzca un postback al servidor. El control especificado para controlar el postback y un argumento de cadena con información adicional sobre el evento definen la cadena de referencia.
GetPostBackEventReference(Control, String, Boolean)	Devuelve una cadena que se debe utilizar en un evento de cliente para que se produzca un postback al servidor. El control especificado para controlar el postback y un argumento de cadena con información adicional sobre el evento definen la cadena de referencia. Opcionalmente, registra la referencia de evento para su validación.
GetPostBackEventReference(PostBackOptions)	Devuelve una cadena que se puede utilizar en un evento de cliente para que se produzca un postback al servidor. La instancia PostBackOptions especificada define la cadena de referencia.
GetPostBackEventReference(PostBackOptions, Boolean)	Devuelve una cadena que se puede utilizar en un evento de cliente para que se produzca un postback al servidor. El objeto PostBackOptions especificado define la cadena de referencia. Opcionalmente, registra la referencia de evento para su validación.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
GetWebResourceUrl(Type, String)	Obtiene una referencia de la dirección URL de un recurso en un ensamblado.
IsClientScriptBlockRegistered(String)	Determina si el bloque de script de cliente se encuentra registrado con el objeto Page utilizando la clave especificada.
IsClientScriptBlockRegistered(Type, String)	Determina si el bloque de script de cliente se encuentra registrado con el objeto Page utilizando una clave y un tipo.
IsClientScriptIncludeRegistered(String)	Determina si la inclusión de script de cliente se encuentra registrada con el objeto Page utilizando la clave especificada.
IsClientScriptIncludeRegistered(Type, String)	Determina si la inclusión de script de cliente se encuentra registrada con el objeto Page utilizando una clave y un tipo.
IsOnSubmitStatementRegistered(String)	Determina si la instrucción OnSubmit se encuentra registrada con el objeto Page utilizando la clave especificada.
IsOnSubmitStatementRegistered(Type, String)	Determina si la instrucción OnSubmit se encuentra registrada con el objeto Page utilizando la clave y el tipo especificados.
IsStartupScriptRegistered(String)	Determina si el script de inicio se encuentra registrado con el objeto Page utilizando la clave especificada.
IsStartupScriptRegistered(Type, String)	Determina si el script de inicio se encuentra registrado con el objeto Page utilizando la clave y el tipo especificados.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
RegisterArrayDeclaration(String, String)	Registra una declaración de matriz JavaScript con el objeto Page utilizando un nombre y un valor de matriz.
RegisterClientScriptBlock(Type, String, String)	Registra el script de cliente con el objeto Page utilizando un tipo, clave y literal de script.
RegisterClientScriptBlock(Type, String, String, Boolean)	Registra el script de cliente con el objeto Page utilizando un tipo, clave, literal de script y valor booleano que indican si se agregan etiquetas de script.
RegisterClientScriptInclude(String, String)	Registra el script de cliente con el objeto Page utilizando una clave y una dirección URL que permiten que se llame desde el script del cliente.
RegisterClientScriptInclude(Type, String, String)	Registra la inclusión de script de cliente con el objeto Page utilizando un tipo, una clave y una dirección URL.
RegisterClientScriptResource(Type, String)	Registra el recurso de script de cliente con el objeto Page utilizando un tipo y un nombre de recurso.
RegisterExpandoAttribute(String, String, String)	Registra un par de nombre y valor como atributo personalizado (expando) del control especificado incluyendo un Id. de control, nombre de atributo y valor de atributo.
RegisterExpandoAttribute(String, String, String, Boolean)	Registra un par de nombre y valor como atributo personalizado (expando) del control especificado proporcionando un Id. de control, un nombre de atributo, un valor de atributo y un valor booleano que indica si se codifica el valor de atributo.
RegisterForEventValidation(PostBackOptions)	Registra una referencia de evento para su validación con PostBackOptions.
RegisterForEventValidation(String)	Registra una referencia de evento para su validación con un identificador de control único que representa el control de cliente que genera el evento.
RegisterForEventValidation(String, String)	Registra una referencia de evento para su validación con un identificador de control único y argumentos de evento que representan el control de cliente que genera el evento.
RegisterHiddenField(String, String)	Registra un valor oculto con el objeto Page.
RegisterOnSubmitStatement(Type, String, String)	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.
RegisterStartupScript(Type, String, String)	Registra el script de inicio con el objeto Page utilizando un tipo, una clave y un literal de script.
RegisterStartupScript(Type, String, String, Boolean)	Registra el script de inicio con el objeto Page utilizando un tipo, una clave, un literal de script y un valor booleano que indican si se agregan etiquetas de script.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
ValidateEvent(String)	Valida un evento de cliente que se registró para la validación de eventos mediante el método RegisterForEventValidation(String).
ValidateEvent(String, String)	Valida un evento de cliente que se registró para la validación de eventos mediante el método RegisterForEventValidation(String, String).

Se aplica a

ClientScriptManager Clase

Definición

Ejemplos

Comentarios

Métodos

Se aplica a

Consulte también

Comentarios

Recursos adicionales