ClientScriptManager.RegisterStartupScript Метод

Определение

Регистрирует скрипт, активизируемый при запуске, с объектом Page.Registers the startup script with the Page object.

Перегрузки

RegisterStartupScript(Type, String, String)

Регистрирует скрипт, активизируемый при запуске, с объектом Page, используя тип, ключ и константу скрипта.Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean)

Регистрирует клиентский скрипт с объектом Page, используя тип, ключ, константу скрипта и логическое значение, указывающее следует ли добавлять теги скрипта.Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

RegisterStartupScript(Type, String, String)

Регистрирует скрипт, активизируемый при запуске, с объектом Page, используя тип, ключ и константу скрипта.Registers the startup script with the Page object using a type, a key, and a script literal.

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

Параметры

type
Type

Тип регистрируемого скрипта, активизируемого при запуске.The type of the startup script to register.

key
String

Ключ регистрируемого скрипта, активизируемого при запуске.The key of the startup script to register.

script
String

Константа регистрируемого скрипта, активизируемого при запуске.The startup script literal to register.

Примеры

В следующем примере кода показано использование RegisterStartupScript метода.The following code example demonstrates the use of the RegisterStartupScript method. Обратите внимание, что начальный и закрывающий теги скрипта script включены в параметр.Note that the beginning and closing script tags are included within the script parameter. Чтобы добавить теги скрипта на основе дополнительного параметра, см RegisterStartupScript . метод.To have the script tags added based on an additional parameter setting, see the RegisterStartupScript method.

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

Комментарии

Клиентский скрипт однозначно идентифицируется по ключу и типу.A client script is uniquely identified by its key and its type. Скрипты с одинаковыми ключом и типом считаются дубликатами.Scripts with the same key and type are considered duplicates. На странице можно зарегистрировать только один скрипт с заданным типом и парой ключей.Only one script with a given type and key pair can be registered with the page. При попытке регистрации скрипта, который уже зарегистрирован, не создается дубликат скрипта.Attempting to register a script that is already registered does not create a duplicate of the script.

Вызовите IsStartupScriptRegistered метод, чтобы определить, уже зарегистрирован ли скрипт запуска с заданным ключом и парой типов, и избежать ненужной попытки добавить скрипт.Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

В этой перегрузке RegisterStartupScript метода необходимо убедиться, что скрипт, предоставленный script в <script> параметре, заключен в блок элемента.In this overload of the RegisterStartupScript method, you must make sure that the script provided in the script parameter is wrapped with a <script> element block.

Блок скрипта, добавленный RegisterStartupScript методом, выполняется при завершении загрузки страницы, но до возникновения OnLoad события страницы.The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. Не гарантируется, что блоки сценариев будут выводиться в том порядке, в котором они зарегистрированы.The script blocks are not guaranteed to be output in the order they are registered. Если важен порядок блоков скрипта, используйте StringBuilder объект для сбора скриптов в одной строке, а затем зарегистрируйте их в одном блоке клиентского сценария.If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

Дополнительно

RegisterStartupScript(Type, String, String, Boolean)

Регистрирует клиентский скрипт с объектом Page, используя тип, ключ, константу скрипта и логическое значение, указывающее следует ли добавлять теги скрипта.Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

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

Параметры

type
Type

Тип регистрируемого скрипта, активизируемого при запуске.The type of the startup script to register.

key
String

Ключ регистрируемого скрипта, активизируемого при запуске.The key of the startup script to register.

script
String

Константа регистрируемого скрипта, активизируемого при запуске.The startup script literal to register.

addScriptTags
Boolean

Логическое значение, указывающее, требуется ли добавление тегов скрипта.A Boolean value indicating whether to add script tags.

Исключения

Свойство type имеет значение null.type is null.

Примеры

В следующем примере кода показано использование RegisterStartupScript метода.The following code example demonstrates the use of the RegisterStartupScript method. Обратите внимание addScriptTags , что параметр имеет false значение, поэтому начальный и закрывающий script теги скрипта включаются в параметр.Note that the addScriptTags parameter is set to false so the beginning and closing script tags are included with the script parameter.

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

Комментарии

Сценарий запуска однозначно идентифицируется по ключу и его типу.A startup script is uniquely identified by its key and its type. Скрипты с одинаковыми ключом и типом считаются дубликатами.Scripts with the same key and type are considered duplicates. На странице можно зарегистрировать только один скрипт с заданным типом и парой ключей.Only one script with a given type and key pair can be registered with the page. При попытке регистрации скрипта, который уже зарегистрирован, не создается дубликат скрипта.Attempting to register a script that is already registered does not create a duplicate of the script.

Вызовите IsStartupScriptRegistered метод, чтобы определить, уже зарегистрирован ли скрипт запуска с заданным ключом и парой типов, и избежать ненужной попытки добавить скрипт.Call the IsStartupScriptRegistered method to determine whether a startup script with a given key and type pair is already registered and avoid unnecessarily attempting to add the script.

В этой перегрузке RegisterStartupScript метода можно указать, упакован ли скрипт, предоставленный script в <script> параметре, блоком элементов с помощью addScriptTags параметра.In this overload of the RegisterStartupScript method, you can indicate whether the script provided in the script parameter is wrapped with a <script> element block by using the addScriptTags parameter. Значение addScriptTagsуказывает,что тегискриптабудутдобавлятьсяавтоматически.trueSetting addScriptTags to true indicates that script tags will be added automatically.

Блок скрипта, добавленный RegisterStartupScript методом, выполняется при завершении загрузки страницы, но до возникновения OnLoad события страницы.The script block added by the RegisterStartupScript method executes when the page finishes loading but before the page's OnLoad event is raised. Не гарантируется, что блоки сценариев будут выводиться в том порядке, в котором они зарегистрированы.The script blocks are not guaranteed to be output in the order they are registered. Если важен порядок блоков скрипта, используйте StringBuilder объект для сбора скриптов в одной строке, а затем зарегистрируйте их в одном блоке клиентского сценария.If the order of the script blocks is important, use a StringBuilder object to gather the scripts together in a single string, and then register them all in a single client script block.

Дополнительно

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