Compartilhar via

ClientScriptManager.IsClientScriptIncludeRegistered Método

  • Referência

Definição

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Determina se o script de cliente de inclusão está registrado com o objeto Page.

Sobrecargas

IsClientScriptIncludeRegistered(String)

Determina se o script de cliente de inclusão está registrado com o objeto Page usando a chave especificada.
IsClientScriptIncludeRegistered(Type, String)

Determina se o script de cliente de inclusão está registrado com o objeto Page usando uma chave e um tipo.

IsClientScriptIncludeRegistered(String)

Determina se o script de cliente de inclusão está registrado com o objeto Page usando a chave especificada.

public:
 bool IsClientScriptIncludeRegistered(System::String ^ key);
public bool IsClientScriptIncludeRegistered (string key);
member this.IsClientScriptIncludeRegistered : string -> bool
Public Function IsClientScriptIncludeRegistered (key As String) As Boolean

Parâmetros

key
String

A chave do script de cliente de inclusão a ser pesquisado.

Retornos

Boolean

true se o script de cliente de inclusão estiver registrado; caso contrário, false.

Comentários

Chame esse método antes de chamar o RegisterClientScriptInclude método para evitar o registro de scripts duplicados. Isso é particularmente importante se o script exigir uma grande quantidade de recursos de servidor para criar.

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.

Essa sobrecarga do IsStartupScriptRegistered método chama a sobrecarga que usa um parâmetro e um key type parâmetro com o tipo definido como um Page objeto.

Confira também

Aplica-se a

IsClientScriptIncludeRegistered(Type, String)

Determina se o script de cliente de inclusão está registrado com o objeto Page usando uma chave e um tipo.

public:
 bool IsClientScriptIncludeRegistered(Type ^ type, System::String ^ key);
public bool IsClientScriptIncludeRegistered (Type type, string key);
member this.IsClientScriptIncludeRegistered : Type * string -> bool
Public Function IsClientScriptIncludeRegistered (type As Type, key As String) As Boolean

Parâmetros

type
Type

O tipo do script de cliente de inclusão a ser pesquisado.

key
String

A chave do script de cliente de inclusão a ser pesquisado.

Retornos

Boolean

true se o script de cliente de inclusão estiver registrado; caso contrário, false.

Exceções

ArgumentNullException

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

Exemplos

O exemplo de código a seguir demonstra o uso do IsClientScriptIncludeRegistered método. Observe que, se a lógica para verificar se o script do cliente existente incluiu foi removida, não haveria dois scripts de cliente duplicados no código-fonte HTML da 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 nomeado Script_include.js, com o seguinte conteúdo:

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

Comentários

Chame esse método antes de chamar o RegisterClientScriptInclude método para evitar o registro de script de cliente duplicado. Isso é particularmente importante se o script exigir uma grande quantidade de recursos de servidor para criar.

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. Especifique o tipo com base no objeto que acessará o recurso. Por exemplo, ao usar uma instância de página para acessar o recurso, você especifica o Page tipo.

Confira também

Aplica-se a