ClientScriptManager.RegisterClientScriptInclude Methode

Definitie

Naamruimte:
System.Web.UI
Assembly:
System.Web.dll

Registreert het clientscript dat bij het Page object is opgenomen.

Overloads

Name Description
RegisterClientScriptInclude(String, String)

Registreert het clientscript met het Page object met behulp van een sleutel en een URL, waarmee het script kan worden aangeroepen vanaf de client.
RegisterClientScriptInclude(Type, String, String)

Registreert het clientscript met het Page object met behulp van een type, een sleutel en een URL.

RegisterClientScriptInclude(String, String)

Registreert het clientscript met het Page object met behulp van een sleutel en een URL, waarmee het script kan worden aangeroepen vanaf de 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)

Parameters

key
String

De sleutel van het clientscript moet worden geregistreerd.

url
String

De URL van het clientscript moet worden geregistreerd.

Voorbeelden

Zie voor gerelateerde informatie, inclusief syntaxis, gebruik en een voorbeeld.RegisterClientScriptInclude

Opmerkingen

Een clientscript bevat een unieke identificatie door de sleutel en het bijbehorende type. Scripts met dezelfde sleutel en hetzelfde type worden beschouwd als duplicaten. Er kan slechts één script met een bepaald type en sleutelpaar worden geregistreerd bij de pagina. Als u een script probeert te registreren dat al is geregistreerd, wordt er geen duplicaat van het script gemaakt.

Roep de IsClientScriptIncludeRegistered methode aan om te bepalen of een clientscript met een bepaalde sleutel en typepaar al is geregistreerd en vermijd onnodig een poging om het script toe te voegen.

Note

Gebruik de methode om de client-URL op te ResolveClientUrl lossen. Deze methode gebruikt de context van de URL waarop het wordt aangeroepen om het pad op te lossen.

Deze overbelasting van de RegisterClientScriptInclude methode roept de overbelasting aan die een key, een URLen een type parameter gebruikt.

Met de methode wordt boven aan de weergegeven pagina een scriptblok toegevoegd.

Zie ook

Van toepassing op

RegisterClientScriptInclude(Type, String, String)

Registreert het clientscript met het Page object met behulp van een type, een sleutel en een 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)

Parameters

type
Type

Het type clientscript dat moet worden geregistreerd.

key
String

De sleutel van het clientscript moet worden geregistreerd.

url
String

De URL van het clientscript moet worden geregistreerd.

Uitzonderingen

ArgumentNullException

Het type clientscript is null.

ArgumentException

De URL is null.

– of –

De URL is leeg.

Voorbeelden

In het volgende codevoorbeeld ziet u het gebruik van de RegisterClientScriptInclude methode. Als de logica om te controleren op het bestaande clientscript is verwijderd, zijn er nog steeds geen dubbele clientscripts op de weergegeven pagina omdat de RegisterClientScriptInclude methode controleert op duplicaten. Het voordeel van het controleren is om onnodige berekeningen te verminderen.

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

Voor dit voorbeeld is een JavaScript-bestand met de naam Script_include.js met de volgende inhoud vereist:

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

Opmerkingen

Deze overbelasting van de RegisterClientScriptInclude methode gebruikt sleutel - en URL-parameters om het script te identificeren, evenals een type parameter om de identificatie van het clientscript op te geven. U geeft het type op op basis van het object dat toegang krijgt tot de resource. Wanneer u bijvoorbeeld een Page exemplaar gebruikt om toegang te krijgen tot de resource, geeft u het Page type op.

Note

Gebruik de methode om de client-URL op te ResolveClientUrl lossen. Deze methode gebruikt de context van de URL waarop het wordt aangeroepen om het pad op te lossen.

Met deze methode wordt boven aan de weergegeven pagina een scriptblok toegevoegd.

Zie ook

Van toepassing op