ClientScriptManager.IsClientScriptIncludeRegistered Metod

Definition

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

Avgör om klientskriptet som ingår är registrerat med Page objektet.

Överlagringar

Name Description
IsClientScriptIncludeRegistered(String)

Avgör om klientskriptet är registrerat med objektet med Page den angivna nyckeln.
IsClientScriptIncludeRegistered(Type, String)

Avgör om klientskriptet är registrerat med objektet med Page hjälp av en nyckel och typ.

IsClientScriptIncludeRegistered(String)

Avgör om klientskriptet är registrerat med objektet med Page den angivna nyckeln.

public:
 bool IsClientScriptIncludeRegistered(System::String ^ key);
public bool IsClientScriptIncludeRegistered(string key);
member this.IsClientScriptIncludeRegistered : string -> bool
Public Function IsClientScriptIncludeRegistered (key As String) As Boolean

Parametrar

key
String

Nyckeln i klientskriptet är bland annat att söka efter.

Returer

Boolean

trueom klientskriptet är registrerat. annars . false

Kommentarer

Anropa den här metoden innan du RegisterClientScriptInclude anropar metoden för att undvika att registrera duplicerade skript. Detta är särskilt viktigt om skriptet kräver en stor mängd serverresurser för att skapa.

Ett klientskript som innehåller identifieras unikt av dess nyckel och dess typ. Skript med samma nyckel och typ betraktas som dubbletter.

Den här överlagringen IsStartupScriptRegistered av metoden anropar överbelastningen som tar både en key och en type parameter med typuppsättningen som ett Page objekt.

Se även

Gäller för

IsClientScriptIncludeRegistered(Type, String)

Avgör om klientskriptet är registrerat med objektet med Page hjälp av en nyckel och typ.

public:
 bool IsClientScriptIncludeRegistered(Type ^ type, System::String ^ key);
public bool IsClientScriptIncludeRegistered(Type type, string key);
member this.IsClientScriptIncludeRegistered : Type * string -> bool
Public Function IsClientScriptIncludeRegistered (type As Type, key As String) As Boolean

Parametrar

type
Type

Vilken typ av klientskript som ska sökas efter.

key
String

Nyckeln i klientskriptet är bland annat att söka efter.

Returer

Boolean

trueom klientskriptet är registrerat. annars . false

Undantag

ArgumentNullException

Klientskriptets inkluderingstyp är null.

Exempel

I följande kodexempel visas hur metoden används IsClientScriptIncludeRegistered . Observera att om logiken för att söka efter det befintliga klientskriptet har tagits bort skulle det inte finnas två duplicerade klientskript i HTML-källkoden för 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>

I det här exemplet krävs en JavaScript-fil med namnet Script_include.js, med följande innehåll:

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

Kommentarer

Anropa den här metoden innan du anropar RegisterClientScriptInclude metoden för att undvika att registrera duplicerade klientskript. Detta är särskilt viktigt om skriptet kräver en stor mängd serverresurser för att skapa.

Ett klientskript som innehåller identifieras unikt av dess nyckel och dess typ. Skript med samma nyckel och typ betraktas som dubbletter. Du anger typen baserat på det objekt som ska komma åt resursen. När du till exempel använder en sidinstans för att komma åt resursen anger Page du typen.

Se även

Gäller för