ClientScriptManager.RegisterClientScriptInclude Metodo

Definizione

Registra l'inclusione di script client con l'oggetto Page.

Overload

RegisterClientScriptInclude(String, String)

Registra lo script client con l'oggetto Page utilizzando una chiave e un URL che consente allo script di essere chiamato dal client.

RegisterClientScriptInclude(Type, String, String)

Registra l'inclusione di script client con l'oggetto Page utilizzando un tipo, una chiave e un URL.

RegisterClientScriptInclude(String, String)

Registra lo script client con l'oggetto Page utilizzando una chiave e un URL che consente allo script di essere chiamato dal client.

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)

Parametri

key
String

Chiave dell'inclusione di script client da registrare.

url
String

URL dell'inclusione di script client da registrare.

Esempio

Per informazioni correlate, tra cui sintassi, utilizzo e un esempio, vedere RegisterClientScriptInclude.

Commenti

Uno script client include è identificato in modo univoco dalla chiave e dal relativo tipo. Gli script con la stessa chiave e tipo sono considerati duplicati. Nella pagina è possibile registrare solo uno script con un tipo e una coppia di chiavi specificati. Il tentativo di registrare uno script già registrato non crea un duplicato dello script.

Chiamare il IsClientScriptIncludeRegistered metodo per determinare se uno script client include con una determinata chiave e una coppia di tipi è già registrato ed evitare inutilmente di tentare di aggiungere lo script.

Nota

Per risolvere l'URL del client, usare il ResolveClientUrl metodo . Questo metodo usa il contesto dell'URL in cui viene chiamato per risolvere il percorso.

Questo overload del RegisterClientScriptInclude metodo chiama l'overload che accetta un keyoggetto , un URLoggetto e un type parametro .

Il metodo aggiunge un blocco di script nella parte superiore della pagina sottoposta a rendering.

Vedi anche

Si applica a

RegisterClientScriptInclude(Type, String, String)

Registra l'inclusione di script client con l'oggetto Page utilizzando un tipo, una chiave e un 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)

Parametri

type
Type

Tipo di inclusione di script client da registrare.

key
String

Chiave dell'inclusione di script client da registrare.

url
String

URL dell'inclusione di script client da registrare.

Eccezioni

Il tipo dell'inclusione di script client è null.

L'URL è null.

-oppure- URL vuoto.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso del RegisterClientScriptInclude metodo . Si noti che se la logica per verificare la presenza dello script client esistente è stata rimossa, nella pagina sottoposta a rendering non verranno ancora presenti script client duplicati perché il RegisterClientScriptInclude metodo verifica la presenza di 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>

Questo esempio richiede un file JavaScript denominato Script_include.js con il contenuto seguente:

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

Commenti

Questo overload del RegisterClientScriptInclude metodo accetta parametri chiave e URL per identificare lo script, nonché un type parametro per specificare l'identificazione dello script client. Specificare il tipo in base all'oggetto che accederà alla risorsa. Ad esempio, quando si usa un'istanza Page per accedere alla risorsa, si specifica il Page tipo .

Nota

Per risolvere l'URL del client, usare il ResolveClientUrl metodo . Questo metodo usa il contesto dell'URL in cui viene chiamato per risolvere il percorso.

Questo metodo aggiunge un blocco di script nella parte superiore della pagina sottoposta a rendering.

Vedi anche

Si applica a