ClientScriptManager.RegisterStartupScript Methode

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Registriert das Startskript mit dem Page Objekt.

Überlädt

Name	Beschreibung
RegisterStartupScript(Type, String, String)	Registriert das Startskript mit dem Page Objekt mithilfe eines Typs, eines Schlüssels und eines Skriptliterals.
RegisterStartupScript(Type, String, String, Boolean)	Registriert das Startskript mit dem Page Objekt mithilfe eines Typs, eines Schlüssels, eines Skriptliterals und eines booleschen Werts, der angibt, ob Skripttags hinzugefügt werden sollen.

RegisterStartupScript(Type, String, String)

Registriert das Startskript mit dem Page Objekt mithilfe eines Typs, eines Schlüssels und eines Skriptliterals.

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)

Parameter

type: Type

Der Typ des zu registrierenden Startskripts.

key: String

Der Schlüssel des zu registrierenden Startskripts.

script: String

Das zu registrierende Startskriptliteral.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterStartupScript Methode veranschaulicht. Beachten Sie, dass die Anfangs- und Schließen-Skripttags innerhalb des script Parameters enthalten sind. Wenn die Skripttags basierend auf einer zusätzlichen Parametereinstellung hinzugefügt werden sollen, lesen Sie die RegisterStartupScript Methode.

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

Hinweise

Ein Clientskript wird eindeutig durch seinen Schlüssel und seinen Typ identifiziert. Skripts mit demselben Schlüssel und Typ werden als Duplikate betrachtet. Nur ein Skript mit einem bestimmten Typ und Schlüsselpaar kann mit der Seite registriert werden. Beim Versuch, ein bereits registriertes Skript zu registrieren, wird kein Duplikat des Skripts erstellt.

Rufen Sie die IsStartupScriptRegistered Methode auf, um zu ermitteln, ob ein Startskript mit einem bestimmten Schlüssel- und Typpaar bereits registriert ist, und vermeiden Sie unnötigen Versuch, das Skript hinzuzufügen.

Bei dieser Überladung der RegisterStartupScript Methode müssen Sie sicherstellen, dass das im script Parameter angegebene Skript mit einem <script> Elementblock umbrochen wird.

Der von der RegisterStartupScript Methode hinzugefügte Skriptblock wird ausgeführt, wenn das Laden der Seite abgeschlossen ist, aber bevor das Ereignis der Seite OnLoad ausgelöst wird. Die Skriptblöcke werden nicht garantiert in der Reihenfolge ausgegeben, in der sie registriert sind. Wenn die Reihenfolge der Skriptblöcke wichtig ist, verwenden Sie ein StringBuilder Objekt, um die Skripts in einer einzelnen Zeichenfolge zusammenzusammeln und dann alle in einem einzelnen Clientskriptblock zu registrieren.

Weitere Informationen

RegisterStartupScript(Type, String, String, Boolean)

Gilt für:

RegisterStartupScript(Type, String, String, Boolean)

Registriert das Startskript mit dem Page Objekt mithilfe eines Typs, eines Schlüssels, eines Skriptliterals und eines booleschen Werts, der angibt, ob Skripttags hinzugefügt werden sollen.

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)

Parameter

type: Type

Der Typ des zu registrierenden Startskripts.

key: String

Der Schlüssel des zu registrierenden Startskripts.

script: String

Das zu registrierende Startskriptliteral.

addScriptTags: Boolean

Ein boolescher Wert, der angibt, ob Skripttags hinzugefügt werden sollen.

Ausnahmen

ArgumentNullException

type ist null.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterStartupScript Methode veranschaulicht. Beachten Sie, dass der addScriptTags Parameter so festgelegt false ist, dass die Anfangs- und schließenden Skripttags im script Parameter enthalten sind.

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

Hinweise

Ein Startskript wird eindeutig durch seinen Schlüssel und seinen Typ identifiziert. Skripts mit demselben Schlüssel und Typ werden als Duplikate betrachtet. Nur ein Skript mit einem bestimmten Typ und Schlüsselpaar kann mit der Seite registriert werden. Beim Versuch, ein bereits registriertes Skript zu registrieren, wird kein Duplikat des Skripts erstellt.

In dieser Überladung der RegisterStartupScript Methode können Sie angeben, ob das im script Parameter bereitgestellte Skript mit einem <script> Elementblock mit dem addScriptTags Parameter umbrochen wird. Einstellung addScriptTags , die true angibt, dass Skripttags automatisch hinzugefügt werden.

Weitere Informationen

Gilt für:

Feedback

War diese Seite hilfreich?