ClientScriptManager.RegisterClientScriptInclude Método

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í.

Registra la inclusión de script de cliente con el objeto Page.

Sobrecargas

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.

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.

public:
 void RegisterClientScriptInclude(System::String ^ key, System::String ^ url);

public void RegisterClientScriptInclude (string key, string url);

member this.RegisterClientScriptInclude : string * string -> unit

Public Sub RegisterClientScriptInclude (key As String, url As String)

Parámetros

key: String

Clave de la inclusión de script de cliente que se va a registrar.

url: String

Dirección URL de la inclusión de script de cliente que se va a registrar.

Ejemplos

Para obtener información relacionada, incluida la sintaxis, el uso y un ejemplo, vea RegisterClientScriptInclude.

Comentarios

Un script de cliente incluye una identificación única por su clave y su tipo. Los scripts con la misma clave y tipo se consideran duplicados. Solo se puede registrar un script con un tipo determinado y un par de claves en la página. Al intentar registrar un script que ya está registrado, no se crea un duplicado del script.

Llame al IsClientScriptIncludeRegistered método para determinar si un script de cliente incluye con una clave y un par de tipos dados ya está registrado y evitar que se intente agregar el script innecesariamente.

Nota

Para resolver la dirección URL del cliente, use el ResolveClientUrl método . Este método usa el contexto de la dirección URL en la que se llama para resolver la ruta de acceso.

Esta sobrecarga del RegisterClientScriptInclude método llama a la sobrecarga que toma un keyparámetro , URLy .type

El método agrega un bloque de script en la parte superior de la página representada.

Consulte también

Se aplica a

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.

public:
 void RegisterClientScriptInclude(Type ^ type, System::String ^ key, System::String ^ url);

public void RegisterClientScriptInclude (Type type, string key, string url);

member this.RegisterClientScriptInclude : Type * string * string -> unit

Public Sub RegisterClientScriptInclude (type As Type, key As String, url As String)

Parámetros

type: Type

Tipo de la inclusión de script de cliente que se va a registrar.

key: String

Clave de la inclusión de script de cliente que se va a registrar.

url: String

Dirección URL de la inclusión de script de cliente que se va a registrar.

Excepciones

ArgumentNullException

El tipo de inclusión de script de cliente es null.

ArgumentException

La dirección URL es null.

o bien URL está vacío.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del RegisterClientScriptInclude método . Tenga en cuenta que si se ha quitado la lógica para comprobar si se ha quitado el script de cliente existente, todavía no habrá scripts de cliente duplicados en la página representada porque el RegisterClientScriptInclude método comprueba si hay duplicados. La ventaja de comprobar es reducir el cálculo innecesario.

<%@ 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, type and url of the client script on the page.
        String csname = "ButtonClickScript";
        String csurl = "~/script_include.js";
        Type cstype = this.GetType();

        // Get a ClientScriptManager reference from the Page class.
        ClientScriptManager cs = Page.ClientScript;

        // Check to see if the include script exists already.
        if (!cs.IsClientScriptIncludeRegistered(cstype, csname))
        {
            cs.RegisterClientScriptInclude(cstype, csname, ResolveClientUrl(csurl));
        }

    }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1" runat="server">
     <div>
        <input type="text"
               id="Message"/> 
        <input type="button" 
               value="ClickMe"
               onclick="DoClick()"/>
     </div>
     </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, type and url of the client script on the page.
        Dim csname As String = "ButtonClickScript"
        Dim csurl As String = "~/script_include.js"
        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 include script is already registered.
        If (Not cs.IsClientScriptIncludeRegistered(cstype, csname)) Then
      
            cs.RegisterClientScriptInclude(cstype, csname, ResolveClientUrl(csurl))
      
        End If
    
    End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
     <form id="Form1" runat="server">
     <div>
        <input type="text"
               id="Message"/> 
        <input type="button" 
               value="ClickMe"
               onclick="DoClick()"/>
     </div>
     </form>
</body>
</html>

En este ejemplo se requiere un archivo JavaScript denominado Script_include.js con el siguiente contenido:

function DoClick() {Form1.Message.value='Text from include script.'}

Comentarios

Esta sobrecarga del RegisterClientScriptInclude método toma parámetros de clave y dirección URL para identificar el script, así como un type parámetro para especificar la identificación del script de cliente. Especifique el tipo basado en el objeto al que se va a acceder al recurso. Por ejemplo, cuando se usa una Page instancia para acceder al recurso, se especifica el Page tipo .

Nota

Para resolver la dirección URL del cliente, use el ResolveClientUrl método . Este método usa el contexto de la dirección URL en la que se llama para resolver la ruta de acceso.

Este método agrega un bloque de script en la parte superior de la página representada.

Consulte también

Se aplica a

ClientScriptManager.RegisterClientScriptInclude Método

Definición

Sobrecargas

RegisterClientScriptInclude(String, String)

Parámetros

Ejemplos

Comentarios

Consulte también

Se aplica a

RegisterClientScriptInclude(Type, String, String)

Parámetros

Excepciones

Ejemplos

Comentarios

Consulte también

Se aplica a

Recursos adicionales