ClientScriptManager.RegisterClientScriptBlock Méthode

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 client auprès de l’objet Page .

Surcharges

Nom	Description
RegisterClientScriptBlock(Type, String, String)	Inscrit le script client auprès de l’objet à l’aide Page d’un type, d’une clé et d’un littéral de script.
RegisterClientScriptBlock(Type, String, String, Boolean)	Inscrit le script client auprès de l’objet à l’aide Page d’un type, d’une clé, d’un littéral de script et d’une valeur booléenne indiquant s’il faut ajouter des balises de script.

RegisterClientScriptBlock(Type, String, String)

Inscrit le script client auprès de l’objet à l’aide Page d’un type, d’une clé et d’un littéral de script.

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

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

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

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

Paramètres

type: Type

Type du script client à inscrire.

key: String

Clé du script client à inscrire.

script: String

Littéral du script client à inscrire.

Exemples

L’exemple de code suivant illustre l’utilisation de la RegisterClientScriptBlock 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 script on the page.
    String csName = "ButtonClickScript";
    Type csType = this.GetType();

    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(csType, csName))
    {
      StringBuilder csText = new StringBuilder();
      csText.Append("<script type=\"text/javascript\"> function DoClick() {");
      csText.Append("Form1.Message.value='Text from client script.'; }");
      csText.Append("</script>");
      cs.RegisterClientScriptBlock(csType, csName, csText.ToString());
    }
  }
</script>
<html  >
  <head>
    <title>RegisterClientScriptBlock 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">
    Public Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
        ' Define the name and type of the client script on the page. 
        Dim csName 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 client script is already registered. 
        If Not cs.IsClientScriptBlockRegistered(csType, csName) Then
            Dim csText As New StringBuilder()
            csText.Append("<script type=""text/javascript""> function DoClick() {")
            csText.Append("Form1.Message.value='Text from client script.'; }")
            csText.Append("</script>")
            cs.RegisterClientScriptBlock(csType, csName, csText.ToString())
        End If
    End Sub
</script>
<html  >
  <head>
    <title>RegisterClientScriptBlock 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 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 IsClientScriptBlockRegistered méthode pour déterminer si un script client avec une clé donnée et une paire de types est déjà inscrit et évitez de tenter inutilement d’ajouter le script.

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

La RegisterClientScriptBlock méthode ajoute un bloc de script en haut de la page rendue. Les blocs de script ne sont pas garantis comme étant des sorties 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 seule chaîne, puis inscrivez-les dans un seul bloc de script client.

Voir aussi

RegisterClientScriptBlock(Type, String, String, Boolean)

S’applique à

RegisterClientScriptBlock(Type, String, String, Boolean)

Inscrit le script client auprès de l’objet à l’aide Page d’un type, d’une clé, d’un littéral de script et d’une valeur booléenne indiquant s’il faut ajouter des balises de script.

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

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

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

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

Paramètres

type: Type

Type du script client à inscrire.

key: String

Clé du script client à inscrire.

script: String

Littéral du script client à inscrire.

addScriptTags: Boolean

Valeur booléenne indiquant s’il faut ajouter des balises de script.

Exceptions

ArgumentNullException

Le type de bloc de script client est null.

Exemples

L’exemple de code suivant illustre l’utilisation de la RegisterClientScriptBlock méthode. Notez que le addScriptTags paramètre est défini pour true que les balises de script de début et de fermeture ne soient pas 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

Appelez la IsClientScriptBlockRegistered méthode pour déterminer si un script client avec une clé donnée et une paire de types est déjà inscrit. Cela vous permet d’éviter inutilement de tenter d’ajouter le script.

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

Voir aussi

RegisterClientScriptBlock(Type, String, String)

S’applique à

Commentaires

Est-ce que cette page vous a été utile?