ClientScriptManager.RegisterClientScriptInclude Méthode

Définition

Espace de noms:: System.Web.UI

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Inscrit le script client avec l’objet Page .

Surcharges

Nom	Description
RegisterClientScriptInclude(String, String)	Inscrit le script client auprès de l’objet à l’aide Page d’une clé et d’une URL, ce qui permet au script d’être appelé à partir du client.
RegisterClientScriptInclude(Type, String, String)	Inscrit le script client avec l’objet à l’aide Page d’un type, d’une clé et d’une URL.

RegisterClientScriptInclude(String, String)

Inscrit le script client auprès de l’objet à l’aide Page d’une clé et d’une URL, ce qui permet au script d’être appelé à partir du 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)

Paramètres

key: String

La clé du script client inclut l’inscription.

url: String

L’URL du script client inclut l’inscription.

Exemples

Pour obtenir des informations connexes, notamment la syntaxe, l’utilisation et un exemple, consultez RegisterClientScriptInclude.

Remarques

Un script client inclut est identifié de manière unique par sa clé et son type. Les scripts avec la même clé et le même type sont considérés comme des doublons. Un seul script avec un type et une paire de clés donnés peuvent être inscrits auprès de la page. La tentative d’inscription d’un script déjà inscrit ne crée pas de doublon du script.

Appelez la IsClientScriptIncludeRegistered méthode pour déterminer si un script client inclut avec une clé et une paire de types donnée est déjà inscrit et évitez de tenter inutilement d’ajouter le script.

Note

Pour résoudre l’URL du client, utilisez la ResolveClientUrl méthode. Cette méthode utilise le contexte de l’URL sur laquelle elle est appelée pour résoudre le chemin d’accès.

Cette surcharge de la RegisterClientScriptInclude méthode appelle la surcharge qui prend un key, un URL, et un type paramètre.

La méthode ajoute un bloc de script en haut de la page rendue.

Voir aussi

S’applique à

RegisterClientScriptInclude(Type, String, String)

Inscrit le script client avec l’objet à l’aide Page d’un type, d’une clé et d’une 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)

Paramètres

type: Type

Le type du script client est inclus pour s’inscrire.

key: String

La clé du script client inclut l’inscription.

url: String

L’URL du script client inclut l’inscription.

Exceptions

ArgumentNullException

Le type include du script client est null.

ArgumentException

L’URL est null.

-ou-

L’URL est vide.

Exemples

L’exemple de code suivant illustre l’utilisation de la RegisterClientScriptInclude méthode. Notez que si la logique à vérifier pour le script client existant a été supprimée, il n’y aurait toujours pas de scripts clients en double dans la page rendue, car la RegisterClientScriptInclude méthode vérifie les doublons. L’avantage de la vérification est de réduire les calculs inutiles.

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

Cet exemple nécessite un fichier JavaScript nommé Script_include.js avec le contenu suivant :

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

Remarques

Cette surcharge de la RegisterClientScriptInclude méthode prend des paramètres de clé et d’URL pour identifier le script, ainsi qu’un type paramètre pour spécifier l’identification du script client. Vous spécifiez le type en fonction de l’objet qui accède à la ressource. Par exemple, lorsque vous utilisez une Page instance pour accéder à la ressource, vous spécifiez le Page type.

Note

Pour résoudre l’URL du client, utilisez la ResolveClientUrl méthode. Cette méthode utilise le contexte de l’URL sur laquelle elle est appelée pour résoudre le chemin d’accès.

Cette méthode ajoute un bloc de script en haut de la page rendue.

Voir aussi

S’applique à

Commentaires

Cette page a-t-elle été utile ?