ClientScriptManager.RegisterStartupScript ClientScriptManager.RegisterStartupScript ClientScriptManager.RegisterStartupScript Method

Definición

Registra el script de inicio con el objeto Page.Registers the startup script with the Page object.

Sobrecargas

RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String)

Registra el script de inicio con el objeto Page utilizando un tipo, una clave y un literal de script.Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean)

Registra el script de inicio con el objeto Page utilizando un tipo, una clave, un literal de script y un valor booleano que indican si se agregan etiquetas de script.Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String) RegisterStartupScript(Type, String, String)

Registra el script de inicio con el objeto Page utilizando un tipo, una clave y un literal de script.Registers the startup script with the Page object using a type, a key, and a script literal.

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

Parámetros

type
Type Type Type

Tipo del script de inicio que se va a registrar.The type of the startup script to register.

key
String String String

Clave del script de inicio que se va a registrar.The key of the startup script to register.

script
String String String

Literal del script de inicio que se va a registrar.The startup script literal to register.

Ejemplos

En el ejemplo de código siguiente se muestra el RegisterStartupScript uso del método.The following code example demonstrates the use of the RegisterStartupScript method. Tenga en cuenta que las etiquetas de script de inicio y cierre script se incluyen en el parámetro.Note that the beginning and closing script tags are included within the script parameter. Para que las etiquetas de script se agreguen en función de un valor de RegisterStartupScript parámetro adicional, vea el método.To have the script tags added based on an additional parameter setting, see the RegisterStartupScript method.

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

Comentarios

Un script de cliente se identifica de forma única mediante su clave y su tipo.A client script is uniquely identified by its key and its type. Los scripts con la misma clave y tipo se consideran duplicados.Scripts with the same key and type are considered duplicates. Solo se puede registrar en la página un script con un tipo y un par de claves determinados.Only one script with a given type and key pair can be registered with the page. Al intentar registrar un script que ya está registrado, no se crea un duplicado del script.Attempting to register a script that is already registered does not create a duplicate of the script.

Llame al IsStartupScriptRegistered método para determinar si ya se ha registrado un script de inicio con una clave y un par de tipos determinados y evitar intentos innecesarios de agregar el script.Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

En esta sobrecarga del RegisterStartupScript método, debe asegurarse de que el script proporcionado en el script parámetro se ajusta con un <script> bloque de elementos.In this overload of the RegisterStartupScript method, you must make sure that the script provided in the script parameter is wrapped with a <script> element block.

El bloque de script agregado por RegisterStartupScript el método se ejecuta cuando finaliza la carga de la página, pero OnLoad antes de que se genere el evento de la página.The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. No se garantiza que los bloques de script se generen en el orden en que se registraron.The script blocks are not guaranteed to be output in the order they are registered. Si el orden de los bloques de script es importante, use StringBuilder un objeto para recopilar los scripts juntos en una sola cadena y, a continuación, regístrelo en un solo bloque de script de cliente.If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

Consulte también:

RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean) RegisterStartupScript(Type, String, String, Boolean)

Registra el script de inicio con el objeto Page utilizando un tipo, una clave, un literal de script y un valor booleano que indican si se agregan etiquetas de script.Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

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

Parámetros

type
Type Type Type

Tipo del script de inicio que se va a registrar.The type of the startup script to register.

key
String String String

Clave del script de inicio que se va a registrar.The key of the startup script to register.

script
String String String

Literal del script de inicio que se va a registrar.The startup script literal to register.

addScriptTags
Boolean Boolean Boolean

Valor booleano que indica si se agregan etiquetas de script.A Boolean value indicating whether to add script tags.

Excepciones

Ejemplos

En el ejemplo de código siguiente se muestra el RegisterStartupScript uso del método.The following code example demonstrates the use of the RegisterStartupScript method. Tenga en cuenta addScriptTags que el parámetro se false establece en para que las etiquetas de script de inicio y script cierre se incluyan con el parámetro.Note that the addScriptTags parameter is set to false so the beginning and closing script tags are included with the script parameter.

<%@ 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 inicio se identifica de forma única mediante su clave y su tipo.A startup script is uniquely identified by its key and its type. Los scripts con la misma clave y tipo se consideran duplicados.Scripts with the same key and type are considered duplicates. Solo se puede registrar en la página un script con un tipo y un par de claves determinados.Only one script with a given type and key pair can be registered with the page. Al intentar registrar un script que ya está registrado, no se crea un duplicado del script.Attempting to register a script that is already registered does not create a duplicate of the script.

Llame al IsStartupScriptRegistered método para determinar si ya se ha registrado un script de inicio con una clave y un par de tipos determinados y evitar intentos innecesarios de agregar el script.Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

En esta sobrecarga RegisterStartupScript del 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.In this overload of the RegisterStartupScript method, you can indicate whether the script provided in the script parameter is wrapped with a <script> element block by using the addScriptTags parameter. Si addScriptTags se true establece en, indica que las etiquetas de script se agregarán automáticamente.Setting addScriptTags to true indicates that script tags will be added automatically.

El bloque de script agregado por RegisterStartupScript el método se ejecuta cuando finaliza la carga de la página, pero OnLoad antes de que se genere el evento de la página.The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. No se garantiza que los bloques de script se generen en el orden en que se registraron.The script blocks are not guaranteed to be output in the order they are registered. Si el orden de los bloques de script es importante, use StringBuilder un objeto para recopilar los scripts juntos en una sola cadena y, a continuación, regístrelo en un solo bloque de script de cliente.If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

Consulte también:

Se aplica a