ClientScriptManager.IsClientScriptIncludeRegistered Metodo

  • Riferimento

Definizione

Spazio dei nomi:
System.Web.UI
Assembly:
System.Web.dll

Determina se l'inclusione di script client è registrata con l'oggetto Page.

Overload

IsClientScriptIncludeRegistered(String)

Determina se l'inclusione di script client è stata registrata con l'oggetto Page utilizzando la chiave specificata.
IsClientScriptIncludeRegistered(Type, String)

Determina se l'inclusione di script client è stata registrata con l'oggetto Page utilizzando una chiave e un tipo.

IsClientScriptIncludeRegistered(String)

Determina se l'inclusione di script client è stata registrata con l'oggetto Page utilizzando la chiave specificata.

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

Parametri

key
String

Chiave dell'inclusione di script client da cercare.

Restituisce

Boolean

true se l'inclusione di script client è registrata; in caso contrario, false.

Commenti

Chiamare questo metodo prima di chiamare il RegisterClientScriptInclude metodo per evitare di registrare script duplicati. Ciò è particolarmente importante se lo script richiede una grande quantità di risorse server da creare.

Uno script client include è identificato in modo univoco dalla chiave e dal relativo tipo. Gli script con la stessa chiave e tipo vengono considerati duplicati.

Questo overload del IsStartupScriptRegistered metodo chiama l'overload che accetta sia un key parametro che un type parametro con il tipo impostato come Page oggetto.

Vedi anche

Si applica a

IsClientScriptIncludeRegistered(Type, String)

Determina se l'inclusione di script client è stata registrata con l'oggetto Page utilizzando una chiave e un 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

Parametri

type
Type

Tipo di inclusione di script client da cercare.

key
String

Chiave dell'inclusione di script client da cercare.

Restituisce

Boolean

true se l'inclusione di script client è registrata; in caso contrario, false.

Eccezioni

ArgumentNullException

Il tipo dell'inclusione di script client è null.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso IsClientScriptIncludeRegistered del metodo. Si noti che, se la logica per verificare la presenza dello script client esistente è stata rimossa, non sono presenti due script client duplicati nel codice sorgente HTML della pagina di cui è stato eseguito il rendering perché il RegisterClientScriptInclude metodo controlla i duplicati. Il vantaggio del controllo consiste nel ridurre il calcolo non necessario.

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

In questo esempio è necessario un file JavaScript denominato Script_include.js, con il contenuto seguente:

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

Commenti

Chiamare questo metodo prima di chiamare il RegisterClientScriptInclude metodo per evitare di registrare lo script client duplicato include. Ciò è particolarmente importante se lo script richiede una grande quantità di risorse server da creare.

Uno script client include è identificato in modo univoco dalla chiave e dal relativo tipo. Gli script con la stessa chiave e tipo vengono considerati duplicati. Specificare il tipo in base all'oggetto che accederà alla risorsa. Ad esempio, quando si usa un'istanza di Pagina per accedere alla risorsa, si specifica il Page tipo.

Vedi anche

Si applica a