ClientScriptManager.RegisterClientScriptInclude Methode

Definition

Registriert den Clientskriptinclude für das Page-Objekt.Registers the client script include with the Page object.

Ü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.Registers the client script with the Page object using a key and a URL, which enables the script to be called from the client.

RegisterClientScriptInclude(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie einer URL den Clientskriptinclude für das Page-Objekt.Registers the client script include with the Page object using a type, a key, and a URL.

RegisterClientScriptInclude(String, String)

Registriert das Clientskript beim Page-Objekt mit einem Schlüssel und einer URL, wodurch das Skript vom Client aufgerufen werden kann.Registers the client script with the Page object using a key and a URL, which enables the script to be called from the 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)

Parameter

key
String

Der Schlüssel des zu registrierenden Clientskriptincludes.The key of the client script include to register.

url
String

Die URL des zu registrierenden Clientskriptincludes.The URL of the client script include to register.

Beispiele

Weitere Informationen, einschließlich Syntax, Verwendung und einem Beispiel, finden RegisterClientScriptIncludeSie unter.For related information, including syntax, usage, and an example, see RegisterClientScriptInclude.

Hinweise

Ein Clientskriptinclude wird durch seinen Schlüssel und dessen Typ eindeutig identifiziert.A client script include is uniquely identified by its key and its type. Skripts mit demselben Schlüssel und Typ werden als Duplikate angesehen.Scripts with the same key and type are considered duplicates. Bei der Seite kann nur ein Skript mit einem bestimmten Typ und Schlüsselpaar registriert werden.Only one script with a given type and key pair can be registered with the page. Wenn Sie versuchen, ein Skript zu registrieren, das bereits registriert ist, wird kein Duplikat des Skripts erstellt.Attempting to register a script that is already registered does not create a duplicate of the script.

Ruft die IsClientScriptIncludeRegistered -Methode auf, um zu bestimmen, ob ein Client Skript mit einem bestimmten Schlüssel und typpaar bereits registriert ist, und vermeidet unnötige Versuche, das Skript hinzuzufügen.Call the IsClientScriptIncludeRegistered method to determine whether a client script include with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

Hinweis

Verwenden Sie die ResolveClientUrl -Methode, um die Client-URL aufzulösen.To resolve the client URL, use the ResolveClientUrl method. Diese Methode verwendet den Kontext der URL, für die Sie aufgerufen wird, um den Pfad aufzulösen.This method uses the context of the URL on which it is called to resolve the path.

Diese Überladung der RegisterClientScriptInclude -Methode ruft die-Überladung keyauf, URLdie einen- type , einen-und einen-Parameter annimmt.This overload of the RegisterClientScriptInclude method calls the overload that takes a key, a URL, and a type parameter.

Die-Methode fügt am oberen Rand der gerenderten Seite einen Skriptblock hinzu.The method adds a script block at the top of the rendered page.

Siehe auch

RegisterClientScriptInclude(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie einer URL den Clientskriptinclude für das Page-Objekt.Registers the client script include with the Page object using a type, a key, and a 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

Parameter

type
Type

Der Typ des zu registrierenden Clientskriptincludes.The type of the client script include to register.

key
String

Der Schlüssel des zu registrierenden Clientskriptincludes.The key of the client script include to register.

url
String

Die URL des zu registrierenden Clientskriptincludes.The URL of the client script include to register.

Ausnahmen

Der Typ des Clientskriptincludes ist null.The client script include type is null.

Die URL ist null.The URL is null.

- oder --or- Der URL ist leer.The URL is empty.

Beispiele

Im folgenden Codebeispiel wird die Verwendung RegisterClientScriptInclude der-Methode veranschaulicht.The following code example demonstrates the use of the RegisterClientScriptInclude method. Beachten Sie Folgendes: Wenn die Logik zum Überprüfen der vorhandenen Client Skripts entfernt wurde, sind auf der gerenderten Seite immer noch keine doppelten Client RegisterClientScriptInclude Skripts vorhanden, da die-Methode auf Duplikate prüft.Note that if the logic to check for the existing client script include were removed, there would still not be duplicate client scripts in the rendered page because the RegisterClientScriptInclude method checks for duplicates. Der Vorteil der Überprüfung besteht darin, unnötige Berechnungen zu verringern.The benefit of checking is to reduce unnecessary computation.

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

Für dieses Beispiel ist eine JavaScript-Datei mit dem Namen Script_include. js mit folgendem Inhalt erforderlich:This example requires a JavaScript file named Script_include.js with the following contents:

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

Hinweise

Diese Überladung der RegisterClientScriptInclude -Methode übernimmt Key -und URL -Parameter, um das Skript zu identifizieren type , sowie einen Parameter, um die Identifizierung des Client Skripts anzugeben.This overload of the RegisterClientScriptInclude method takes key and url parameters to identify the script, as well as a type parameter to specify the identification of the client script include. Sie geben den Typ basierend auf dem Objekt an, das auf die Ressource zugreift.You specify the type based on the object that will be accessing the resource. Wenn Sie beispielsweise für den Page Zugriff auf die Ressource eine-Instanz verwenden, Page geben Sie den Typ an.For instance, when using a Page instance to access the resource, you specify the Page type.

Hinweis

Verwenden Sie die ResolveClientUrl -Methode, um die Client-URL aufzulösen.To resolve the client URL, use the ResolveClientUrl method. Diese Methode verwendet den Kontext der URL, für die Sie aufgerufen wird, um den Pfad aufzulösen.This method uses the context of the URL on which it is called to resolve the path.

Diese Methode fügt am oberen Rand der gerenderten Seite einen Skriptblock hinzu.This method adds a script block at the top of the rendered page.

Siehe auch

Gilt für: