ClientScriptManager.RegisterClientScriptInclude Methode

  • Referenz

Definition

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

Registriert den Clientskriptinclude für das Page-Objekt.

Überlädt

RegisterClientScriptInclude(String, String)

Registriert das Clientskript beim Page-Objekt mit einem Schlüssel und einer URL, wodurch das Skript vom Client aufgerufen werden kann.
RegisterClientScriptInclude(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie einer URL den Clientskriptinclude für das Page-Objekt.

RegisterClientScriptInclude(String, String)

Registriert das Clientskript beim Page-Objekt mit einem Schlüssel und einer URL, wodurch das Skript vom Client aufgerufen werden kann.

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)

Parameter

key
String

Der Schlüssel des zu registrierenden Clientskriptincludes.

url
String

Die URL des zu registrierenden Clientskriptincludes.

Beispiele

Verwandte Informationen, einschließlich Syntax, Verwendung und ein Beispiel, finden Sie unter RegisterClientScriptInclude.

Hinweise

Ein Clientskript ist eindeutig durch seinen Schlüssel und seinen Typ identifiziert. Skripts mit demselben Schlüssel und Typ werden als Duplikate betrachtet. Nur ein Skript mit einem bestimmten Typ und Schlüsselpaar kann mit der Seite registriert werden. Wenn Sie versuchen, ein bereits registriertes Skript zu registrieren, wird kein Duplikat des Skripts erstellt.

Rufen Sie die IsClientScriptIncludeRegistered Methode auf, um zu ermitteln, ob ein Clientskript mit einem bestimmten Schlüssel- und Typpaar bereits registriert ist und nicht unnötig versucht, das Skript hinzuzufügen.

Hinweis

Verwenden Sie die Methode, um die ResolveClientUrl Client-URL zu beheben. Diese Methode verwendet den Kontext der URL, auf der der Pfad aufgelöst werden soll.

Diese Überladung der RegisterClientScriptInclude Methode ruft die Überladung auf, die einen , a key``URLund einen type Parameter verwendet.

Die Methode fügt oben auf der gerenderten Seite einen Skriptblock hinzu.

Siehe auch

Gilt für

RegisterClientScriptInclude(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie einer URL den Clientskriptinclude für das Page-Objekt.

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)

Parameter

type
Type

Der Typ des zu registrierenden Clientskriptincludes.

key
String

Der Schlüssel des zu registrierenden Clientskriptincludes.

url
String

Die URL des zu registrierenden Clientskriptincludes.

Ausnahmen

ArgumentNullException

Der Typ des Clientskriptincludes ist null.

ArgumentException

Die URL ist null.

- oder - Der URL ist leer.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterClientScriptInclude Methode veranschaulicht. Beachten Sie, dass, wenn die Logik zum Überprüfen auf das vorhandene Clientskript entfernt wurde, weiterhin keine doppelten Clientskripts auf der gerenderten Seite vorhanden wären, da die RegisterClientScriptInclude Methode nach Duplikaten sucht. Der Vorteil der Überprüfung besteht darin, unnötige Berechnungen zu reduzieren.

<%@ 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 diesem Beispiel ist eine JavaScript-Datei mit dem Namen Script_include.js mit den folgenden Inhalten erforderlich:

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

Hinweise

Diese Überladung der RegisterClientScriptInclude Methode verwendet Schlüssel - und URL-Parameter , um das Skript zu identifizieren, sowie einen type Parameter, um die Identifizierung des Clientskripts anzugeben. Sie geben den Typ basierend auf dem Objekt an, das auf die Ressource zugreift. Wenn Sie beispielsweise eine Page Instanz verwenden, um auf die Ressource zuzugreifen, geben Sie den Page Typ an.

Hinweis

Verwenden Sie die Methode, um die ResolveClientUrl Client-URL zu beheben. Diese Methode verwendet den Kontext der URL, auf der der Pfad aufgelöst werden soll.

Diese Methode fügt oben auf der gerenderten Seite einen Skriptblock hinzu.

Siehe auch

Gilt für