ClientScriptManager.RegisterClientScriptInclude Methode

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Registriert das Clientskript, das im Page Objekt enthalten ist.

Überlädt

Name	Beschreibung
RegisterClientScriptInclude(String, String)	Registriert das Clientskript mit dem Page Objekt mithilfe eines Schlüssels und einer URL, wodurch das Skript vom Client aufgerufen werden kann.
RegisterClientScriptInclude(Type, String, String)	Registriert das Clientskript, das Page das Objekt mit einem Typ, einem Schlüssel und einer URL enthält.

RegisterClientScriptInclude(String, String)

Registriert das Clientskript mit dem Page Objekt mithilfe eines Schlüssels 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 Clientskripts umfasst die Registrierung.

url: String

Die URL des Clientskripts enthält die Registrierung.

Beispiele

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

Hinweise

Ein Clientskript wird 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. Beim Versuch, 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 vermeiden Sie unnötigerweise, das Skript hinzuzufügen.

Note

Verwenden Sie die ResolveClientUrl Methode, um die Client-URL aufzulösen. Diese Methode verwendet den Kontext der URL, in der sie aufgerufen wird, um den Pfad aufzulösen.

Diese Überladung der RegisterClientScriptInclude Methode ruft die Überladung auf, die einen , a keyURLund einen type Parameter akzeptiert.

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

Weitere Informationen

Gilt für:

RegisterClientScriptInclude(Type, String, String)

Registriert das Clientskript, das Page das Objekt mit einem Typ, einem Schlüssel und einer URL enthält.

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 Clientskripts.

key: String

Der Schlüssel des Clientskripts umfasst die Registrierung.

url: String

Die URL des Clientskripts enthält die Registrierung.

Ausnahmen

ArgumentNullException

Der Typ des Clientskripts ist null.

ArgumentException

Die URL ist null.

-oder-

Die URL ist leer.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterClientScriptInclude Methode veranschaulicht. Beachten Sie, dass, wenn die zu überprüfende Logik für das vorhandene Clientskript entfernt wurde, immer noch keine doppelten Clientskripts auf der gerenderten Seite vorhanden wären, da die RegisterClientScriptInclude Methode auf Duplikate überprüft. 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 dem folgenden Inhalt 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 Identifikation des Clientskripts anzugeben. Sie geben den Typ basierend auf dem Objekt an, das auf die Ressource zugreift. Wenn Sie beispielsweise eine Page Instanz für den Zugriff auf die Ressource verwenden, geben Sie den Page Typ an.

Note

Verwenden Sie die ResolveClientUrl Methode, um die Client-URL aufzulösen. Diese Methode verwendet den Kontext der URL, in der sie aufgerufen wird, um den Pfad aufzulösen.

Mit dieser Methode wird oben auf der gerenderten Seite ein Skriptblock hinzugefügt.

Weitere Informationen

Gilt für:

Feedback

War diese Seite hilfreich?