ClientScriptManager.IsStartupScriptRegistered Méthode

  • Référence

Définition

Espace de noms:
System.Web.UI
Assembly:
System.Web.dll

Détermine si le script de démarrage est inscrit avec l'objet Page.

Surcharges

IsStartupScriptRegistered(Type, String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé et du type spécifiés.
IsStartupScriptRegistered(String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé spécifiée.

IsStartupScriptRegistered(Type, String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé et du type spécifiés.

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

Paramètres

type
Type

Type du script de démarrage à rechercher.

key
String

Clé du script de démarrage à rechercher.

Retours

Boolean

true si le script de démarrage est inscrit ; sinon, false.

Exceptions

ArgumentNullException

Le type du script de démarrage est null.

Exemples

L’exemple de code suivant illustre l’utilisation de la IsStartupScriptRegistered méthode . Notez que, si la logique permettant de vérifier le bloc de script de démarrage existant était supprimée, il n’y aurait pas deux scripts de démarrage en double dans le code source HTML de la page rendue, car la RegisterStartupScript méthode recherche les doublons. L’avantage de la vérification est de réduire les calculs inutiles.

<%@ 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 and type of the client scripts on the page.
    String csname1 = "PopupScript";
    String csname2 = "ButtonClickScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the startup script is already registered.
    if (!cs.IsStartupScriptRegistered(cstype, csname1))
    {
      String cstext1 = "alert('Hello World');";
      cs.RegisterStartupScript(cstype, csname1, cstext1, true);
    }

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(cstype, csname2))
    {
      StringBuilder cstext2 = new StringBuilder();
      cstext2.Append("<script type=\"text/javascript\"> function DoClick() {");
      cstext2.Append("Form1.Message.value='Text from client script.'} </");
      cstext2.Append("script>");
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), false);
    }
  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </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 and type of the client scripts on the page.
    Dim csname1 As String = "PopupScript"
    Dim csname2 As String = "ButtonClickScript"
    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 startup script is already registered.
    If (Not cs.IsStartupScriptRegistered(cstype, csname1)) Then
      
      Dim cstext1 As String = "alert('Hello World');"
      cs.RegisterStartupScript(cstype, csname1, cstext1, True)
      
    End If
    
    ' Check to see if the client script is already registered.
    If (Not cs.IsClientScriptBlockRegistered(cstype, csname2)) Then
      
      Dim cstext2 As New StringBuilder()
            cstext2.Append("<script type=""text/javascript""> function DoClick() {")
      cstext2.Append("Form1.Message.value='Text from client script.'} </")
      cstext2.Append("script>")
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), False)
      
    End If
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>

Remarques

Appelez cette méthode avant d’appeler la RegisterStartupScript méthode pour éviter d’inscrire des scripts en double. Cela est particulièrement important si le script nécessite une grande quantité de ressources serveur à créer.

Un script de démarrage client est identifié de manière unique par sa clé et son type. Les scripts avec la même clé et le même type sont considérés comme des doublons.

Voir aussi

S’applique à

IsStartupScriptRegistered(String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé spécifiée.

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

Paramètres

key
String

Clé du script de démarrage à rechercher.

Retours

Boolean

true si le script de démarrage est inscrit ; sinon, false.

Remarques

Appelez cette méthode avant d’appeler la RegisterStartupScript méthode pour éviter d’inscrire des scripts en double. Cela est particulièrement important si le script nécessite une grande quantité de ressources serveur à créer.

Un script de démarrage est identifié de manière unique par sa clé et son type. Les scripts avec la même clé et le même type sont considérés comme des doublons.

Cette surcharge de la IsStartupScriptRegistered méthode appelle la surcharge qui accepte à la fois une chaîne key et un type paramètre avec le type défini en tant qu’objet Page

Voir aussi

S’applique à