ClientScriptManager.RegisterClientScriptBlock Метод

Определение

Регистрирует клиентский скрипт в объекте Page .

Перегрузки

Имя Описание
RegisterClientScriptBlock(Type, String, String)

Регистрирует клиентский Page скрипт с объектом с помощью литерала типа, ключа и скрипта.

RegisterClientScriptBlock(Type, String, String, Boolean)

Регистрирует клиентский скрипт с Page объектом с помощью типа, ключа, литерала скрипта и логического значения, указывающего, следует ли добавлять теги скриптов.

RegisterClientScriptBlock(Type, String, String)

Регистрирует клиентский Page скрипт с объектом с помощью литерала типа, ключа и скрипта.

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)

Параметры

type
Type

Тип клиентского скрипта для регистрации.

key
String

Ключ клиентского скрипта для регистрации.

script
String

Литерал клиентского скрипта для регистрации.

Примеры

В следующем примере кода показано использование 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>

Комментарии

Скрипт клиента однозначно определяется его ключом и типом. Скрипты с тем же ключом и типом считаются дубликатами. На странице можно зарегистрировать только один скрипт с заданным типом и парой ключей. Попытка зарегистрировать скрипт, который уже зарегистрирован, не создает дубликат скрипта.

IsClientScriptBlockRegistered Вызовите метод, чтобы определить, зарегистрирован ли клиентский скрипт с заданным ключом и парой типов, и избежать ненужных попыток добавления скрипта.

В этой перегрузке RegisterClientScriptBlock метода необходимо убедиться, что скрипт, указанный в параметре script , упакован в <script> блок элементов.

Метод RegisterClientScriptBlock добавляет блок скрипта в верхнюю часть отрисовки страницы. Блоки скриптов не гарантированы выходными данными в том порядке, в который они зарегистрированы. Если порядок блоков скриптов важен, используйте StringBuilder объект для сбора скриптов в одной строке, а затем зарегистрируйте их в одном блоке клиентских скриптов.

См. также раздел

Применяется к

RegisterClientScriptBlock(Type, String, String, Boolean)

Регистрирует клиентский скрипт с Page объектом с помощью типа, ключа, литерала скрипта и логического значения, указывающего, следует ли добавлять теги скриптов.

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)

Параметры

type
Type

Тип клиентского скрипта для регистрации.

key
String

Ключ клиентского скрипта для регистрации.

script
String

Литерал клиентского скрипта для регистрации.

addScriptTags
Boolean

Логическое значение, указывающее, следует ли добавлять теги скрипта.

Исключения

Тип блока клиентского скрипта .null

Примеры

В следующем примере кода показано использование RegisterClientScriptBlock метода. Обратите внимание, что параметр задан addScriptTags так, чтобы true теги начального и закрывающего скрипта не включались в 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>

Комментарии

Скрипт клиента однозначно определяется его ключом и типом. Скрипты с тем же ключом и типом считаются дубликатами. На странице можно зарегистрировать только один скрипт с заданным типом и парой ключей. Попытка зарегистрировать скрипт, который уже зарегистрирован, не создает дубликат скрипта.

IsClientScriptBlockRegistered Вызовите метод, чтобы определить, зарегистрирован ли клиентский скрипт с заданной парой ключей и типа. Это позволяет избежать ненужных попыток добавления скрипта.

В этой перегрузке RegisterClientScriptBlock метода можно указать, упаковывается script ли скрипт, предоставленный в <script> параметре, блоком элемента с помощью addScriptTags параметра. Параметр addScriptTags , указывающий true , что теги скрипта будут добавлены автоматически.

Метод RegisterClientScriptBlock добавляет блок скрипта в верхнюю часть отрисовки страницы. Блоки скриптов не гарантированы выходными данными в том порядке, в который они зарегистрированы. Если порядок блоков скриптов важен, используйте StringBuilder объект для сбора скриптов в одной строке, а затем зарегистрируйте их в одном блоке клиентских скриптов.

См. также раздел

Применяется к