ClientScriptManager.RegisterStartupScript Metodo

Definizione

Registra lo script di avvio con l'oggetto Page.

Overload

RegisterStartupScript(Type, String, String)

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

RegisterStartupScript(Type, String, String, Boolean)

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

RegisterStartupScript(Type, String, String)

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

Parametri

type
Type

Tipo dello script di avvio da registrare.

key
String

Chiave dello script di avvio da registrare.

script
String

Valore letterale dello script di avvio da registrare.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso del RegisterStartupScript metodo . Si noti che i tag di script iniziale e di chiusura sono inclusi nel script parametro . Per aggiungere i tag di script in base a un'impostazione di parametro aggiuntiva, vedere il RegisterStartupScript 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 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>

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 IsStartupScriptRegistered metodo per determinare se uno script di avvio con una determinata chiave e una coppia di tipi è già registrato ed evitare inutilmente di tentare di aggiungere lo script.

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

Il blocco di script aggiunto dal RegisterStartupScript metodo viene eseguito al termine del caricamento della pagina, ma prima che venga generato l'evento della OnLoad pagina. 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

RegisterStartupScript(Type, String, String, Boolean)

Registra lo script di avvio 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 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)

Parametri

type
Type

Tipo dello script di avvio da registrare.

key
String

Chiave dello script di avvio da registrare.

script
String

Valore letterale dello script di avvio da registrare.

addScriptTags
Boolean

Valore Boolean che indica se aggiungere tag script.

Eccezioni

type è null.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso del RegisterStartupScript metodo . Si noti che il addScriptTags parametro è impostato su false in modo che i tag di script iniziale e di chiusura 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 di avvio viene identificato in modo univoco dalla relativa 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 IsStartupScriptRegistered metodo per determinare se uno script di avvio con una determinata chiave e una coppia di tipi è già registrato ed evitare inutilmente di tentare di aggiungere lo script.

In questo overload del RegisterStartupScript 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 addScriptTags true indica che i tag di script verranno aggiunti automaticamente.

Il blocco di script aggiunto dal RegisterStartupScript metodo viene eseguito al termine del caricamento della pagina, ma prima che venga generato l'evento della OnLoad pagina. 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