Condividi tramite


ClientScriptManager.RegisterClientScriptBlock Metodo

Definizione

Registra lo script client con l'oggetto Page.

Overload

RegisterClientScriptBlock(Type, String, String)

Registra lo script client con l'oggetto Page utilizzando un tipo, una chiave e un valore letterale di script.

RegisterClientScriptBlock(Type, String, String, Boolean)

Registra lo script client con l'oggetto Page utilizzando un tipo, una chiave, un valore letterale di script e un valore Boolean che indica se aggiungere tag script.

RegisterClientScriptBlock(Type, String, String)

Registra lo script client con l'oggetto Page utilizzando un tipo, una chiave e un valore letterale di 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)

Parametri

type
Type

Tipo di script client da registrare.

key
String

Chiave dello script client da registrare.

script
String

Valore letterale dello script client da registrare.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso del RegisterClientScriptBlock metodo .

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

Commenti

Uno script client viene identificato in modo univoco dalla chiave e dal relativo tipo. Gli script con la stessa chiave e tipo sono considerati duplicati. Nella pagina è possibile registrare solo uno script con un tipo e una coppia di chiavi specificati. Il tentativo di registrare uno script già registrato non crea un duplicato dello script.

Chiamare il IsClientScriptBlockRegistered metodo per determinare se uno script client con una chiave e una coppia di tipi specificati è già registrato ed evitare inutilmente di tentare di aggiungere lo script.

In questo overload del RegisterClientScriptBlock metodo è necessario assicurarsi che lo script fornito nel script parametro sia sottoposto a wrapping in un blocco di <script> elementi.

Il RegisterClientScriptBlock metodo aggiunge un blocco di script alla parte superiore della pagina sottoposta a rendering. Non è garantito che i blocchi di script vengano restituiti nell'ordine in cui vengono registrati. Se l'ordine dei blocchi di script è importante, usare un StringBuilder oggetto per raccogliere gli script in una singola stringa e quindi registrarli tutti in un singolo blocco di script client.

Vedi anche

Si applica a

RegisterClientScriptBlock(Type, String, String, Boolean)

Registra lo script client con l'oggetto Page utilizzando un tipo, una chiave, un valore letterale di script e un valore Boolean che indica se aggiungere tag 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)

Parametri

type
Type

Tipo di script client da registrare.

key
String

Chiave dello script client da registrare.

script
String

Valore letterale dello script client da registrare.

addScriptTags
Boolean

Valore Boolean che indica se aggiungere tag script.

Eccezioni

Il tipo di blocco di script client è null.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso del RegisterClientScriptBlock metodo . Si noti che il addScriptTags parametro è impostato su true in modo che i tag di script iniziale e di chiusura non siano inclusi nel script parametro .

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

Commenti

Uno script client viene identificato in modo univoco dalla chiave e dal relativo tipo. Gli script con la stessa chiave e tipo sono considerati duplicati. Nella pagina è possibile registrare solo uno script con un tipo e una coppia di chiavi specificati. Il tentativo di registrare uno script già registrato non crea un duplicato dello script.

Chiamare il IsClientScriptBlockRegistered metodo per determinare se uno script client con una chiave e una coppia di tipi specificati è già registrato. In questo modo è possibile evitare inutilmente di tentare di aggiungere lo script.

In questo overload del RegisterClientScriptBlock metodo è possibile indicare se lo script fornito nel parametro viene sottoposto a script wrapping con un <script> blocco di elementi usando il addScriptTags parametro . L'impostazione su addScriptTagstrue indica che i tag di script verranno aggiunti automaticamente.

Il RegisterClientScriptBlock metodo aggiunge un blocco di script alla parte superiore della pagina sottoposta a rendering. Non è garantito che i blocchi di script vengano restituiti nell'ordine in cui vengono registrati. Se l'ordine dei blocchi di script è importante, usare un StringBuilder oggetto per raccogliere gli script in una singola stringa e quindi registrarli tutti in un singolo blocco di script client.

Vedi anche

Si applica a