ClientScriptManager.RegisterClientScriptInclude Método

Referência

Definição

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Registra o script de cliente de inclusão com o objeto Page.

Sobrecargas

RegisterClientScriptInclude(String, String)	Registra o script de cliente com o objeto Page usando uma chave e uma URL, que permite que o script seja chamado pelo cliente.
RegisterClientScriptInclude(Type, String, String)	Registra o script de cliente incluído no objeto Page usando um tipo, uma chave e uma URL.

RegisterClientScriptInclude(String, String)

Registra o script de cliente com o objeto Page usando uma chave e uma URL, que permite que o script seja chamado pelo 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

A chave do script de cliente que será registrada.

url: String

A URL do script de cliente que será registrada.

Exemplos

Para obter informações relacionadas, incluindo sintaxe, uso e um exemplo, consulte RegisterClientScriptInclude.

Comentários

Uma inclusão de script de cliente é identificada exclusivamente por sua chave e seu tipo. Scripts com a mesma chave e tipo são considerados duplicados. Somente um script com determinado tipo e par de chaves pode ser registrado com a página. A tentativa de registrar um script já registrado não cria uma duplicata do script.

Chame o IsClientScriptIncludeRegistered método para determinar se um script de cliente inclui com uma determinada chave e um par de tipos já está registrado e evite tentar adicionar o script desnecessariamente.

Observação

Para resolver a URL do cliente, use o ResolveClientUrl método. Esse método usa o contexto da URL na qual é chamado para resolver o caminho.

Essa sobrecarga do RegisterClientScriptInclude método chama a sobrecarga que usa um parâmetro e um key``URL``type parâmetro.

O método adiciona um bloco de script na parte superior da página renderizada.

Confira também

Aplica-se a

RegisterClientScriptInclude(Type, String, String)

Registra o script de cliente incluído no objeto Page usando um tipo, uma chave e uma 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

O tipo do script de cliente que será registrado.

key: String

A chave do script de cliente que será registrada.

url: String

A URL do script de cliente que será registrada.

Exceções

ArgumentNullException

O tipo do script de cliente de inclusão é null.

ArgumentException

A URL é null.

- ou - A URL está vazia.

Exemplos

O exemplo de código a seguir demonstra o uso do RegisterClientScriptInclude método. Observe que se a lógica para verificar se o script do cliente existente incluem foi removida, ainda não haveria scripts de cliente duplicados na página renderizada porque o RegisterClientScriptInclude método verifica se há duplicatas. O benefício da verificação é reduzir a computação desnecessária.

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

Este exemplo requer um arquivo JavaScript chamado Script_include.js com o seguinte conteúdo:

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

Comentários

Essa sobrecarga do RegisterClientScriptInclude método usa parâmetros de chave e url para identificar o script, bem como um type parâmetro para especificar a identificação do script do cliente incluem. Especifique o tipo com base no objeto que acessará o recurso. Por exemplo, ao usar uma Page instância para acessar o recurso, você especifica o Page tipo.

Observação

Para resolver a URL do cliente, use o ResolveClientUrl método. Esse método usa o contexto da URL na qual é chamado para resolver o caminho.

Esse método adiciona um bloco de script na parte superior da página renderizada.

Confira também

Aplica-se a

Compartilhar via

ClientScriptManager.RegisterClientScriptInclude Método

Definição

Sobrecargas

RegisterClientScriptInclude(String, String)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

RegisterClientScriptInclude(Type, String, String)

Parâmetros

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

Recursos adicionais