ClientScriptManager.RegisterClientScriptBlock Metódus

Definíció

Névtér:
System.Web.UI
Szerelvény:
System.Web.dll

Regisztrálja az ügyfélszkriptet az Page objektummal.

Túlterhelések

Name Description
RegisterClientScriptBlock(Type, String, String)

Az ügyfélszkriptet típus, kulcs és szkriptkonstans használatával regisztrálja az Page objektummal.
RegisterClientScriptBlock(Type, String, String, Boolean)

Az ügyfélszkriptet egy típus, kulcs, szkriptkonstans és logikai érték használatával regisztrálja az Page objektummal, amely jelzi, hogy szkriptcímkéket szeretne-e hozzáadni.

RegisterClientScriptBlock(Type, String, String)

Az ügyfélszkriptet típus, kulcs és szkriptkonstans használatával regisztrálja az Page objektummal.

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)

Paraméterek

type
Type

A regisztrálandó ügyfélszkript típusa.

key
String

A regisztrálandó ügyfélszkript kulcsa.

script
String

A regisztrálandó ügyfélszkript literálja.

Példák

Az alábbi példakód a metódus használatát RegisterClientScriptBlock mutatja be.

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

Megjegyzések

Az ügyfélszkripteket a kulcs és a típus egyedileg azonosítja. Az azonos kulccsal és típussal rendelkező szkriptek duplikáltnak minősülnek. A lapon csak egy adott típusú és kulcspárt tartalmazó szkript regisztrálható. Ha már regisztrált szkriptet próbál regisztrálni, az nem hozza létre a szkript másolatát.

Hívja meg a IsClientScriptBlockRegistered metódust annak megállapításához, hogy egy adott kulccsal és típuspárral rendelkező ügyfélszkript már regisztrálva van-e, és ne próbálja meg szükségtelenül hozzáadni a szkriptet.

A metódus túlterhelése RegisterClientScriptBlock esetén meg kell győződnie arról, hogy a script paraméterben megadott szkript egy <script> elemblokkba van csomagolva.

A RegisterClientScriptBlock metódus egy szkriptblokkot ad hozzá a renderelt oldal tetejére. A szkriptblokkok nem garantáltan abban a sorrendben jelennek meg, amelyben regisztrálva vannak. Ha a szkriptblokkok sorrendje fontos, használjon objektumot StringBuilder a szkriptek egyetlen sztringben való összegyűjtéséhez, majd regisztrálja őket egyetlen ügyfélszkriptblokkban.

Lásd még

A következőre érvényes:

RegisterClientScriptBlock(Type, String, String, Boolean)

Az ügyfélszkriptet egy típus, kulcs, szkriptkonstans és logikai érték használatával regisztrálja az Page objektummal, amely jelzi, hogy szkriptcímkéket szeretne-e hozzáadni.

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)

Paraméterek

type
Type

A regisztrálandó ügyfélszkript típusa.

key
String

A regisztrálandó ügyfélszkript kulcsa.

script
String

A regisztrálandó ügyfélszkript literálja.

addScriptTags
Boolean

Logikai érték, amely azt jelzi, hogy szkriptcímkéket szeretne-e hozzáadni.

Kivételek

ArgumentNullException

Az ügyfélszkript blokktípusa.null

Példák

Az alábbi példakód a metódus használatát RegisterClientScriptBlock mutatja be. Vegye figyelembe, hogy a addScriptTags paraméter úgy van beállítva, hogy true az első és a záró szkriptcímkék ne legyenek belefoglalva a script paraméterbe.

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

Megjegyzések

Az ügyfélszkripteket a kulcs és a típus egyedileg azonosítja. Az azonos kulccsal és típussal rendelkező szkriptek duplikáltnak minősülnek. A lapon csak egy adott típusú és kulcspárt tartalmazó szkript regisztrálható. Ha már regisztrált szkriptet próbál regisztrálni, az nem hozza létre a szkript másolatát.

Hívja meg a IsClientScriptBlockRegistered metódust annak megállapításához, hogy egy adott kulccsal és típuspárral rendelkező ügyfélszkript már regisztrálva van-e. Így elkerülheti a szkript szükségtelen hozzáadását.

A metódus túlterhelése RegisterClientScriptBlock esetén jelezheti, hogy a paraméterben script megadott szkript elemblokkba <script> van-e csomagolva a addScriptTags paraméter használatával. A beállítás addScriptTags azt true jelzi, hogy a szkriptcímkék automatikusan hozzá lesznek adva.

A RegisterClientScriptBlock metódus egy szkriptblokkot ad hozzá a renderelt oldal tetejére. A szkriptblokkok nem garantáltan abban a sorrendben jelennek meg, amelyben regisztrálva vannak. Ha a szkriptblokkok sorrendje fontos, használjon objektumot StringBuilder a szkriptek egyetlen sztringben való összegyűjtéséhez, majd regisztrálja őket egyetlen ügyfélszkriptblokkban.

Lásd még

A következőre érvényes: