ClientScriptManager.RegisterStartupScript Метод

Ссылка

Определение

Пространство имен:: System.Web.UI

Сборка:: System.Web.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Регистрирует скрипт, активизируемый при запуске, с объектом Page.

Перегрузки

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

RegisterStartupScript(Type, String, String)

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

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)

Параметры

type: Type

Тип регистрируемого скрипта, активизируемого при запуске.

key: String

Ключ регистрируемого скрипта, активизируемого при запуске.

script: String

Константа регистрируемого скрипта, активизируемого при запуске.

Примеры

В следующем примере кода демонстрируется использование RegisterStartupScript метода. Обратите внимание, что теги начального и закрывающего скриптов включаются в script параметр. Сведения о добавлении тегов скриптов на основе дополнительного параметра см. в этом методе RegisterStartupScript .

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

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

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

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

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

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

RegisterStartupScript(Type, String, String, Boolean)

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

RegisterStartupScript(Type, String, String, Boolean)

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

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)

Параметры

type: Type

Тип регистрируемого скрипта, активизируемого при запуске.

key: String

Ключ регистрируемого скрипта, активизируемого при запуске.

script: String

Константа регистрируемого скрипта, активизируемого при запуске.

addScriptTags: Boolean

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

Исключения

ArgumentNullException

type имеет значение null.

Примеры

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

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

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

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

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

ClientScriptManager.RegisterStartupScript Метод

Определение

Перегрузки

RegisterStartupScript(Type, String, String)

Параметры

Примеры

Комментарии

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

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

RegisterStartupScript(Type, String, String, Boolean)

Параметры

Исключения

Примеры

Комментарии

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

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

Дополнительные ресурсы