ClientScriptManager.RegisterStartupScript Méthode

Référence

Définition

Espace de noms:: System.Web.UI

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Inscrit le script de démarrage avec l'objet Page.

Surcharges

RegisterStartupScript(Type, String, String)	Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé et d'un littéral de script.
RegisterStartupScript(Type, String, String, Boolean)	Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé, d'un littéral de script et d'une valeur Boolean indiquant s'il faut ajouter des balises de script.

RegisterStartupScript(Type, String, String)

Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé et d'un littéral de script.

public:
 void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script);

public void RegisterStartupScript (Type type, string key, string script);

member this.RegisterStartupScript : Type * string * string -> unit

Public Sub RegisterStartupScript (type As Type, key As String, script As String)

Paramètres

type: Type

Type du script de démarrage à inscrire.

key: String

Clé du script de démarrage à inscrire.

script: String

Littéral du script de démarrage à inscrire.

Exemples

L’exemple de code suivant illustre l’utilisation de la RegisterStartupScript méthode. Notez que les balises de script de début et de fermeture sont incluses dans le script paramètre. Pour que les balises de script aient été ajoutées en fonction d’un paramètre supplémentaire, consultez la RegisterStartupScript méthode.

<%@ 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";
    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))
    {
        StringBuilder cstext1 = new StringBuilder();
        cstext1.Append("<script type=text/javascript> alert('Hello World!') </");
        cstext1.Append("script>");

        cs.RegisterStartupScript(cstype, csname1, cstext1.ToString());
    }
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>RegisterStartupScript</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
    </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">
    Public Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
        ' Define the name and type of the client scripts on the page. 
        Dim csname1 As [String] = "PopupScript"
        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 New StringBuilder()
            cstext1.Append("<script type=text/javascript> alert('Hello World!') </")
            cstext1.Append("script>")
        
            cs.RegisterStartupScript(cstype, csname1, cstext1.ToString())
        End If
    End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>RegisterStartupScript</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
    </div>
    </form>
</body>
</html>

Remarques

Un script 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. Un seul script avec un type et une paire de clés donnés peuvent être inscrits auprès de la page. La tentative d’inscription d’un script déjà inscrit ne crée pas de doublon du script.

Appelez la IsStartupScriptRegistered méthode pour déterminer si un script de démarrage avec une clé donnée et une paire de types est déjà inscrit et évitez inutilement d’ajouter le script.

Dans cette surcharge de la RegisterStartupScript méthode, vous devez vous assurer que le script fourni dans le script paramètre est encapsulé avec un bloc d’éléments <script> .

Le bloc de script ajouté par la méthode s’exécute lorsque la RegisterStartupScript page se termine au chargement, mais avant que l’événement de OnLoad la page soit déclenché. Les blocs de script ne sont pas garantis d’être en sortie dans l’ordre dans lequel ils sont inscrits. Si l’ordre des blocs de script est important, utilisez un StringBuilder objet pour rassembler les scripts ensemble dans une seule chaîne, puis inscrivez-les dans un seul bloc de script client.

Voir aussi

RegisterStartupScript(Type, String, String, Boolean)

S’applique à

RegisterStartupScript(Type, String, String, Boolean)

Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé, d'un littéral de script et d'une valeur Boolean indiquant s'il faut ajouter des balises de script.

public:
 void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script, bool addScriptTags);

public void RegisterStartupScript (Type type, string key, string script, bool addScriptTags);

member this.RegisterStartupScript : Type * string * string * bool -> unit

Public Sub RegisterStartupScript (type As Type, key As String, script As String, addScriptTags As Boolean)

Paramètres

type: Type

Type du script de démarrage à inscrire.

key: String

Clé du script de démarrage à inscrire.

script: String

Littéral du script de démarrage à inscrire.

addScriptTags: Boolean

Valeur Boolean qui indique s'il faut ajouter des balises de script.

Exceptions

ArgumentNullException

type a la valeur null.

Exemples

L’exemple de code suivant illustre l’utilisation de la RegisterStartupScript méthode. Notez que le addScriptTags paramètre est défini pour false que les balises de script de début et de fermeture soient incluses dans le script paramètre.

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

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. Un seul script avec un type et une paire de clés donnés peuvent être inscrits auprès de la page. La tentative d’inscription d’un script déjà inscrit ne crée pas de doublon du script.

Appelez la IsStartupScriptRegistered méthode pour déterminer si un script de démarrage avec une clé donnée et une paire de types est déjà inscrit et évitez inutilement d’ajouter le script.

Dans cette surcharge de la RegisterStartupScript méthode, vous pouvez indiquer si le script fourni dans le paramètre est encapsulé avec un bloc d’élément <script> à l’aide script du addScriptTags paramètre. Paramètre addScriptTags pour true indiquer que les balises de script seront ajoutées automatiquement.

Le bloc de script ajouté par la méthode s’exécute lorsque la RegisterStartupScript page se termine au chargement, mais avant que l’événement de OnLoad la page soit déclenché. Les blocs de script ne sont pas garantis d’être en sortie dans l’ordre dans lequel ils sont inscrits. Si l’ordre des blocs de script est important, utilisez un StringBuilder objet pour rassembler les scripts dans une chaîne unique, puis inscrivez-les tous dans un bloc de script client unique.

Voir aussi

S’applique à

Partager via

ClientScriptManager.RegisterStartupScript Méthode

Définition

Surcharges

RegisterStartupScript(Type, String, String)

Paramètres

Exemples

Remarques

Voir aussi

S’applique à

RegisterStartupScript(Type, String, String, Boolean)

Paramètres

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

Ressources supplémentaires