ClientScriptManager.RegisterClientScriptBlock 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 Clientskript mit dem Page Objekt.

Überlädt

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

RegisterClientScriptBlock(Type, String, String)

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

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)

Parameter

type: Type

Der Typ des zu registrierenden Clientskripts.

key: String

Der Schlüssel des zu registrierenden Clientskripts.

script: String

Das zu registrierende Clientskriptliteral.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterClientScriptBlock Methode veranschaulicht.

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

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 IsClientScriptBlockRegistered Methode auf, um zu ermitteln, ob ein Clientskript mit einem bestimmten Schlüssel- und Typpaar bereits registriert ist, und vermeiden Sie unnötigen Versuch, das Skript hinzuzufügen.

In dieser Überladung der RegisterClientScriptBlock Methode müssen Sie sicherstellen, dass das im script Parameter bereitgestellte Skript in einen <script> Elementblock eingeschlossen ist.

Die RegisterClientScriptBlock Methode fügt oben auf der gerenderten Seite einen Skriptblock hinzu. 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

RegisterClientScriptBlock(Type, String, String, Boolean)

Gilt für:

RegisterClientScriptBlock(Type, String, String, Boolean)

Registriert das Clientskript 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 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)

Parameter

type: Type

Der Typ des zu registrierenden Clientskripts.

key: String

Der Schlüssel des zu registrierenden Clientskripts.

script: String

Das zu registrierende Clientskriptliteral.

addScriptTags: Boolean

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

Ausnahmen

ArgumentNullException

Der Clientskriptblocktyp ist null.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der RegisterClientScriptBlock Methode veranschaulicht. Beachten Sie, dass der addScriptTags Parameter so true festgelegt ist, dass die Anfangs- und schließenden Skripttags nicht 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

Rufen Sie die IsClientScriptBlockRegistered Methode auf, um zu ermitteln, ob ein Clientskript mit einem bestimmten Schlüssel und Typpaar bereits registriert ist. Auf diese Weise können Sie nicht unnötig versuchen, das Skript hinzuzufügen.

In dieser Überladung der RegisterClientScriptBlock 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

RegisterClientScriptBlock(Type, String, String)

Gilt für:

Feedback

War diese Seite hilfreich?