ClientScriptManager.RegisterClientScriptInclude Metod

Definition

Namnområde:
System.Web.UI
Sammansättning:
System.Web.dll

Registrerar klientskriptet som ingår i Page objektet.

Överlagringar

Name Description
RegisterClientScriptInclude(String, String)

Registrerar klientskriptet med objektet med Page hjälp av en nyckel och en URL, vilket gör att skriptet kan anropas från klienten.
RegisterClientScriptInclude(Type, String, String)

Registrerar klientskriptet med objektet med Page hjälp av en typ, en nyckel och en URL.

RegisterClientScriptInclude(String, String)

Registrerar klientskriptet med objektet med Page hjälp av en nyckel och en URL, vilket gör att skriptet kan anropas från klienten.

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)

Parametrar

key
String

Nyckeln för klientskriptet är att registrera.

url
String

URL:en för klientskriptet innehåller för att registrera.

Exempel

Relaterad information, inklusive syntax, användning och ett exempel, finns i RegisterClientScriptInclude.

Kommentarer

Ett klientskript som innehåller identifieras unikt av dess nyckel och dess typ. Skript med samma nyckel och typ betraktas som dubbletter. Endast ett skript med en viss typ och ett nyckelpar kan registreras på sidan. Försök att registrera ett skript som redan är registrerat skapar inte en dubblett av skriptet.

IsClientScriptIncludeRegistered Anropa metoden för att avgöra om ett klientskript innehåller med en viss nyckel och typpar redan har registrerats och undvik onödigt försök att lägga till skriptet.

Note

Använd metoden för ResolveClientUrl att lösa klient-URL:en. Den här metoden använder kontexten för den URL som den anropas för att lösa sökvägen.

Den här överlagringen RegisterClientScriptInclude av metoden anropar den överlagring som tar en key, en URLoch en type parameter.

Metoden lägger till ett skriptblock överst på den renderade sidan.

Se även

Gäller för

RegisterClientScriptInclude(Type, String, String)

Registrerar klientskriptet med objektet med Page hjälp av en typ, en nyckel och en 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)

Parametrar

type
Type

Vilken typ av klientskript som ska registreras.

key
String

Nyckeln för klientskriptet är att registrera.

url
String

URL:en för klientskriptet innehåller för att registrera.

Undantag

ArgumentNullException

Klientskriptets inkluderingstyp är null.

ArgumentException

URL:en är null.

-eller-

URL:en är tom.

Exempel

I följande kodexempel visas hur metoden används RegisterClientScriptInclude . Observera att om logiken för att söka efter det befintliga klientskriptet har tagits bort skulle det fortfarande inte finnas duplicerade klientskript på den renderade sidan eftersom RegisterClientScriptInclude metoden söker efter dubbletter. Fördelen med att kontrollera är att minska onödig beräkning.

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

Det här exemplet kräver en JavaScript-fil med namnet Script_include.js med följande innehåll:

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

Kommentarer

Den här överlagringen RegisterClientScriptInclude av metoden tar nyckel- och URL-parametrar för att identifiera skriptet, samt en type parameter för att ange identifieringen av klientskriptet. Du anger typen baserat på det objekt som ska komma åt resursen. När du till exempel använder en Page instans för att komma åt resursen anger Page du typen.

Note

Använd metoden för ResolveClientUrl att lösa klient-URL:en. Den här metoden använder kontexten för den URL som den anropas för att lösa sökvägen.

Den här metoden lägger till ett skriptblock överst på den renderade sidan.

Se även

Gäller för