Compartir vía

ClientScriptManager.RegisterClientScriptBlock Método

  • Referencia

Definición

Espacio de nombres:
System.Web.UI
Ensamblado:
System.Web.dll

Registra el script de cliente con el objeto Page.

Sobrecargas

RegisterClientScriptBlock(Type, String, String)

Registra el script de cliente con el objeto Page utilizando un tipo, clave y literal de script.
RegisterClientScriptBlock(Type, String, String, Boolean)

Registra el script de cliente con el objeto Page utilizando un tipo, clave, literal de script y valor booleano que indican si se agregan etiquetas de script.

RegisterClientScriptBlock(Type, String, String)

Registra el script de cliente con el objeto Page utilizando un tipo, clave y literal 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)

Parámetros

type
Type

Tipo del script de cliente que se va a registrar.

key
String

Clave del script de cliente que se va a registrar.

script
String

Literal del script de cliente que se va a registrar.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del RegisterClientScriptBlock método .

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

Comentarios

Un script de cliente se identifica de forma única por su clave y su tipo. Los scripts con la misma clave y tipo se consideran duplicados. Solo se puede registrar un script con un tipo determinado y un par de claves en la página. Al intentar registrar un script que ya está registrado, no se crea un duplicado del script.

Llame al IsClientScriptBlockRegistered método para determinar si un script de cliente con una clave y un par de tipos especificados ya está registrado y evitar que se intente agregar el script innecesariamente.

En esta sobrecarga del RegisterClientScriptBlock método, debe asegurarse de que el script proporcionado en el script parámetro se encapsula en un <script> bloque de elementos.

El RegisterClientScriptBlock método agrega un bloque de script a la parte superior de la página representada. No se garantiza que los bloques de script sean de salida en el orden en que están registrados. Si el orden de los bloques de script es importante, use un StringBuilder objeto para recopilar los scripts juntos en una sola cadena y, a continuación, registrarlos todos en un único bloque de script de cliente.

Consulte también

Se aplica a

RegisterClientScriptBlock(Type, String, String, Boolean)

Registra el script de cliente con el objeto Page utilizando un tipo, clave, literal de script y valor booleano que indican si se agregan etiquetas 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)

Parámetros

type
Type

Tipo del script de cliente que se va a registrar.

key
String

Clave del script de cliente que se va a registrar.

script
String

Literal del script de cliente que se va a registrar.

addScriptTags
Boolean

Valor booleano que indica si se agregan etiquetas de script.

Excepciones

ArgumentNullException

El tipo del bloque de script de cliente es null.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del RegisterClientScriptBlock método . Tenga en cuenta que el addScriptTags parámetro se establece en true para que las etiquetas de script inicial y de cierre no se incluyan con el script parámetro .

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

Comentarios

Un script de cliente se identifica de forma única por su clave y su tipo. Los scripts con la misma clave y tipo se consideran duplicados. Solo se puede registrar un script con un tipo determinado y un par de claves en la página. Al intentar registrar un script que ya está registrado, no se crea un duplicado del script.

Llame al IsClientScriptBlockRegistered método para determinar si un script de cliente con una clave y un par de tipos especificados ya está registrado. Esto le permite evitar innecesariamente intentar agregar el script.

En esta sobrecarga del RegisterClientScriptBlock método, puede indicar si el script proporcionado en el script parámetro se ajusta con un <script> bloque de elementos mediante el addScriptTags parámetro . Establecer addScriptTags en true indica que las etiquetas de script se agregarán automáticamente.

El RegisterClientScriptBlock método agrega un bloque de script a la parte superior de la página representada. No se garantiza que los bloques de script sean de salida en el orden en que están registrados. Si el orden de los bloques de script es importante, use un StringBuilder objeto para recopilar los scripts juntos en una sola cadena y, a continuación, registrarlos todos en un único bloque de script de cliente.

Consulte también

Se aplica a