ClientScriptManager.RegisterClientScriptBlock Metod

Definition

Namnområde:: System.Web.UI

Sammansättning:: System.Web.dll

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

Registrerar klientskriptet med Page -objektet.

Överlagringar

Name	Description
RegisterClientScriptBlock(Type, String, String)	Registrerar klientskriptet med objektet med Page hjälp av en typ, nyckel och skriptliteral.
RegisterClientScriptBlock(Type, String, String, Boolean)	Registrerar klientskriptet med objektet med Page hjälp av ett typ-, nyckel-, skriptliteral- och booleskt värde som anger om skripttaggar ska läggas till.

RegisterClientScriptBlock(Type, String, String)

Registrerar klientskriptet med objektet med Page hjälp av en typ, nyckel och skriptliteral.

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)

Parametrar

type: Type

Vilken typ av klientskript som ska registreras.

key: String

Nyckeln för det klientskript som ska registreras.

script: String

Den klientskriptliteral som ska registreras.

Exempel

I följande kodexempel visas hur metoden används RegisterClientScriptBlock .

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

Kommentarer

Ett klientskript identifieras unikt av dess nyckel och dess typ. Skript med samma nyckel och typ betraktas som dubbletter. Endast ett skript med en viss typ och ett nyckelpar kan registreras på sidan. Försök att registrera ett skript som redan är registrerat skapar inte en dubblett av skriptet.

IsClientScriptBlockRegistered Anropa metoden för att avgöra om ett klientskript med en viss nyckel och ett typpar redan är registrerat och undvik att försöka lägga till skriptet i onödan.

I den här överlagringen RegisterClientScriptBlock av metoden måste du se till att skriptet som anges i parametern är omslutet script i ett <script> elementblock.

Metoden RegisterClientScriptBlock lägger till ett skriptblock överst på den renderade sidan. Skriptblocken garanteras inte vara utdata i den ordning de registreras. Om ordningen på skriptblocken är viktig använder du ett StringBuilder -objekt för att samla ihop skripten i en enda sträng och registrerar dem sedan i ett enda klientskriptblock.

Se även

RegisterClientScriptBlock(Type, String, String, Boolean)

Gäller för

RegisterClientScriptBlock(Type, String, String, Boolean)

Registrerar klientskriptet med objektet med Page hjälp av ett typ-, nyckel-, skriptliteral- och booleskt värde som anger om skripttaggar ska läggas till.

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)

Parametrar

type: Type

Vilken typ av klientskript som ska registreras.

key: String

Nyckeln för det klientskript som ska registreras.

script: String

Den klientskriptliteral som ska registreras.

addScriptTags: Boolean

Ett booleskt värde som anger om skripttaggar ska läggas till.

Undantag

ArgumentNullException

Blocktypen för klientskriptet är null.

Exempel

I följande kodexempel visas hur metoden används RegisterClientScriptBlock . Observera att parametern addScriptTags är inställd på så att true taggarna för inledande och avslutande skript inte ingår i parametern script .

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

Kommentarer

IsClientScriptBlockRegistered Anropa metoden för att avgöra om ett klientskript med en viss nyckel och typpar redan är registrerat. På så sätt kan du undvika att försöka lägga till skriptet i onödan.

I den här överlagringen RegisterClientScriptBlock av metoden kan du ange om skriptet som anges i parametern script omsluts med ett <script> elementblock med hjälp av parametern addScriptTags . Inställningen addScriptTags anger true att skripttaggar läggs till automatiskt.

Se även

RegisterClientScriptBlock(Type, String, String)

Gäller för

Feedback

Var den här sidan till hjälp?