ClientScriptManager Класс

Определение

Определяет методы для управления клиентскими скриптами в веб-приложениях.Defines methods for managing client scripts in Web applications.

public ref class ClientScriptManager sealed
public sealed class ClientScriptManager
type ClientScriptManager = class
Public NotInheritable Class ClientScriptManager
Наследование
ClientScriptManager

Примеры

В следующем примере кода показано использование RegisterClientScriptBlock метода ClientScriptManager класса.The following code example demonstrates the use of the RegisterClientScriptBlock method of the ClientScriptManager class. На странице определены два клиентских скрипта: PopupScript, который отображает предупреждающее сообщение при загрузке страницы, и ButtonClickScript, определяющее обработчик клиента onClick для события кнопки HTML.Two client scripts are defined in the page: PopupScript, which displays an alert message when the page is loaded, and ButtonClickScript, which defines a client handler for an HTML button's onClick event.

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

Комментарии

ClientScriptManager Класс используется для управления клиентскими скриптами и их добавления в веб-приложения.The ClientScriptManager class is used to manage client scripts and add them to Web applications. Ссылку на ClientScriptManager класс можно получить ClientScript из свойства Page объекта.You can get a reference to the ClientScriptManager class from the ClientScript property of the Page object.

Клиентский скрипт можно добавить на веб-страницу декларативно, включив скрипт в HTML-разметку страницы.You can add a client script to a Web page declaratively by including the script in the HTML markup of the page. Однако существуют ситуации, когда требуется динамически добавлять клиентский скрипт.However, there are situations when adding client script dynamically is needed. Чтобы динамически добавить скрипт, RegisterClientScriptBlock используйте метод RegisterClientScriptInclude , метод RegisterStartupScript , метод или RegisterOnSubmitStatement метод, в зависимости от того, когда и как нужно добавить скрипт.To add a script dynamically, use the RegisterClientScriptBlock method, the RegisterClientScriptInclude method, the RegisterStartupScript method, or the RegisterOnSubmitStatement method, depending on when and how you want to add the script. Дополнительные сведения см. в разделе Практическое руководство. Динамически добавьте клиентский скрипт ввеб-страницы ASP.NET.For more information, see How to: Add Client Script Dynamically to ASP.NET Web Pages.

Класс однозначно определяет скрипты по ключу String и Type. ClientScriptManagerThe ClientScriptManager class uniquely identifies scripts by a key String and a Type. Скрипты с одинаковыми ключом и типом считаются дубликатами.Scripts with the same key and type are considered duplicates. Использование типа скрипта помогает избежать путаницы похожих сценариев из разных пользовательских элементов управления, которые могут использоваться на странице.Using the script type helps to avoid confusing similar scripts from different user controls that might be in use on the page.

ClientScriptManager Класс можно использовать для вызова клиентских обратных вызовов в ситуациях, когда желательно запускать серверный код из клиента без выполнения обратной передачи.The ClientScriptManager class can be used to invoke client callbacks in situations when it is desirable to run server code from the client without performing a postback. Это называется выполнением нестандартного обратного вызова на сервер.This is referred to as performing an out-of-band callback to the server. При обратном вызове клиента функция клиентского скрипта отправляет асинхронный запрос на веб-страницу ASP.NET.In a client callback, a client script function sends an asynchronous request to an ASP.NET Web page. Веб-страница запускает измененную версию своего обычного жизненного цикла для обработки обратного вызова.The Web page runs a modified version of its normal life cycle to process the callback. GetCallbackEventReference Используйте метод для получения ссылки на клиентскую функцию, которая при вызове инициирует обратный вызов клиента к серверному событию.Use the GetCallbackEventReference method to obtain a reference to a client function that, when invoked, initiates a client callback to a server event. Дополнительные сведения см. в разделе реализация обратных вызовов клиента без обратной передачи.For more information, see Implementing Client Callbacks Without Postbacks.

Примечание

Обратные вызовы сценариев не будут работать в старых браузерах, которые не поддерживают модель DOM (DOM), и для них требуется, чтобы на клиенте был включен ECMAScript.Script callbacks will not work in older browsers that do not support the Document Object Model (DOM), and they require that ECMAScript is enabled on the client. Чтобы проверить, поддерживает ли браузер обратные вызовы, используйте SupportsCallback свойство, доступное Browser через свойство встроенного Request объекта ASP.NET.To check if the browser supports callbacks, use the SupportsCallback property, which is accessible through the Browser property of the ASP.NET intrinsic Request object.

GetPostBackEventReference Используйте методGetPostBackClientHyperlink и метод для определения события обратной передачи клиента.Use the GetPostBackEventReference method and the GetPostBackClientHyperlink method to define a client postback event. Эти методы позволяют выполнять функции клиентского скрипта при вызове, чтобы сервер переводился обратно на страницу.These methods enable client script functions, when invoked, to cause the server to post back to the page. Событие обратной передачи клиента отличается от обратного вызова клиента в том, что веб-страница завершает нормальный жизненный цикл для обработки события обратной передачи клиента.A client postback event is different from a client callback in that the Web page completes a normal life cycle to process the client postback event.

Примечание

Если Button используется элемент управления false UseSubmitBehavior и для свойства задано значение, то можно использовать GetPostBackEventReference метод, чтобы вернуть клиентское событие обратной передачи для Button элемента управления.If you are using a Button control and the UseSubmitBehavior property is set to false, then you can use the GetPostBackEventReference method to return the client postback event for the Button control.

Свойство элемента управления ,ImageButton элемента LinkButton управления и элемента управления можно использовать для запуска клиентского скрипта. Button OnClientClickThe OnClientClick property of the Button control, ImageButton control, and LinkButton control can be used to run client script.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetCallbackEventReference(Control, String, String, String)

Получает ссылку на клиентскую функцию, которая при вызове инициализирует обратный вызов клиента к событию сервера.Obtains a reference to a client function that, when invoked, initiates a client call back to a server event. Клиентская функция для перегруженного метода включает указанный элемент управления, аргумент, клиентский скрипт и контекст.The client function for this overloaded method includes a specified control, argument, client script, and context.

GetCallbackEventReference(Control, String, String, String, Boolean)

Получает ссылку на клиентскую функцию, которая при вызове инициализирует обратный вызов клиента к событиям сервера.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Клиентская функция для перегруженного метода включает указанный элемент управления, аргумент, клиентский скрипт, контекст и логическое значение.The client function for this overloaded method includes a specified control, argument, client script, context, and Boolean value.

GetCallbackEventReference(Control, String, String, String, String, Boolean)

Получает ссылку на клиентскую функцию, которая при вызове инициализирует обратный вызов клиента к событиям сервера.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Клиентская функция для перегруженного метода включает указанный элемент управления, аргумент, клиентский скрипт, контекст, обработчик ошибок и логическое значение.The client function for this overloaded method includes a specified control, argument, client script, context, error handler, and Boolean value.

GetCallbackEventReference(String, String, String, String, String, Boolean)

Получает ссылку на клиентскую функцию, которая при вызове инициализирует обратный вызов клиента к событиям сервера.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Клиентская функция для перегруженного метода включает указанную цель, аргумент, клиентский скрипт, контекст, обработчик ошибок и логическое значение.The client function for this overloaded method includes a specified target, argument, client script, context, error handler, and Boolean value.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetPostBackClientHyperlink(Control, String)

Возвращает ссылку, с javascript: в начале, которую можно использовать в клиентском событии для обратной передачи серверу указанного элемента управления с указанными аргументами события.Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control and with the specified event arguments.

GetPostBackClientHyperlink(Control, String, Boolean)

Возвращает ссылку с добавленным javascript: в начале, которую можно использовать в клиентском событии для обратной передачи серверу для указанного элемента управления с указанными аргументами события и логическим обозначением, следует ли регистрировать обратную передачу для проверки события.Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control with the specified event arguments and Boolean indication whether to register the post back for event validation.

GetPostBackEventReference(Control, String)

Возвращает строку, которая может использоваться в клиентском событии для инициирования обратной передачи серверу.Returns a string that can be used in a client event to cause postback to the server. Строка ссылки определяется указанным элементом управления, обрабатывающим обратную передачу, и строчным аргументом с дополнительной информацией о событии.The reference string is defined by the specified control that handles the postback and a string argument of additional event information.

GetPostBackEventReference(Control, String, Boolean)

Возвращает строку, которая может использоваться в клиентском событии для инициирования обратной передачи серверу.Returns a string to use in a client event to cause postback to the server. Строка ссылки определяется указанным элементом управления, обрабатывающим обратную передачу, и строчным аргументом с дополнительной информацией о событии.The reference string is defined by the specified control that handles the postback and a string argument of additional event information. По выбору регистрирует ссылку на событие для проверки.Optionally, registers the event reference for validation.

GetPostBackEventReference(PostBackOptions)

Возвращает строку, которая может использоваться в клиентском событии для инициирования обратной передачи серверу.Returns a string that can be used in a client event to cause postback to the server. Строка ссылки определяется указанным экземпляром PostBackOptions.The reference string is defined by the specified PostBackOptions instance.

GetPostBackEventReference(PostBackOptions, Boolean)

Возвращает строку, которая может использоваться в клиентском событии для инициирования обратной передачи серверу.Returns a string that can be used in a client event to cause postback to the server. Строка ссылки определяется указанным объектом PostBackOptions.The reference string is defined by the specified PostBackOptions object. По выбору регистрирует ссылку на событие для проверки.Optionally, registers the event reference for validation.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
GetWebResourceUrl(Type, String)

Возвращает ссылку URL-адреса на ресурс в сборке.Gets a URL reference to a resource in an assembly.

IsClientScriptBlockRegistered(String)

Определяет, зарегистрирован ли блок клиентского скрипта с объектом Page, используя указанный ключ.Determines whether the client script block is registered with the Page object using the specified key.

IsClientScriptBlockRegistered(Type, String)

Определяет, зарегистрирован ли блок клиентского скрипта с объектом Page, используя ключ и тип.Determines whether the client script block is registered with the Page object using a key and type.

IsClientScriptIncludeRegistered(String)

Определяет, зарегистрировано ли включение клиентского скрипта с объектом Page, используя указанный ключ.Determines whether the client script include is registered with the Page object using the specified key.

IsClientScriptIncludeRegistered(Type, String)

Определяет, зарегистрировано ли включение клиентского скрипта с объектом Page, используя ключ и тип.Determines whether the client script include is registered with the Page object using a key and type.

IsOnSubmitStatementRegistered(String)

Определяет, зарегистрирован ли оператор OnSubmit с объектом Page, используя указанный ключ.Determines whether the OnSubmit statement is registered with the Page object using the specified key.

IsOnSubmitStatementRegistered(Type, String)

Определяет, зарегистрирован ли оператор OnSubmit с объектом Page, используя указанные ключ и тип.Determines whether the OnSubmit statement is registered with the Page object using the specified key and type.

IsStartupScriptRegistered(String)

Определяет, зарегистрирован ли скрипт, активизируемый при запуске, с объектом Page, используя указанный ключ.Determines whether the startup script is registered with the Page object using the specified key.

IsStartupScriptRegistered(Type, String)

Определяет, зарегистрирован ли скрипт, активизируемый при запуске, с объектом Page, используя указанные ключ и тип.Determines whether the startup script is registered with the Page object using the specified key and type.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
RegisterArrayDeclaration(String, String)

Регистрирует объявление массива JavaScript с объектом Page, используя имя массива и значение массива.Registers a JavaScript array declaration with the Page object using an array name and array value.

RegisterClientScriptBlock(Type, String, String)

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

RegisterClientScriptBlock(Type, String, String, Boolean)

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

RegisterClientScriptInclude(String, String)

Регистрирует клиентский скрипт с объектом Page, используя ключ и URL-адрес, который позволяет вызывать скрипт из клиента.Registers the client script with the Page object using a key and a URL, which enables the script to be called from the client.

RegisterClientScriptInclude(Type, String, String)

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

RegisterClientScriptResource(Type, String)

Регистрирует ресурс клиентского скрипта с объектом Page, используя тип и имя ресурса.Registers the client script resource with the Page object using a type and a resource name.

RegisterExpandoAttribute(String, String, String)

Регистрирует пару "имя-значение" как пользовательский (expando) атрибут указанного элемента управления с указанными идентификатором, именем атрибута и значением атрибута.Registers a name/value pair as a custom (expando) attribute of the specified control given a control ID, attribute name, and attribute value.

RegisterExpandoAttribute(String, String, String, Boolean)

Регистрирует пару "имя-значение" как пользовательский (expando) атрибут указанного элемента управления с указанными идентификатором, именем атрибута, значением атрибута и логическим значением, определяющим, будет ли кодироваться значение атрибута.Registers a name/value pair as a custom (expando) attribute of the specified control given a control ID, an attribute name, an attribute value, and a Boolean value indicating whether to encode the attribute value.

RegisterForEventValidation(PostBackOptions)

Регистрирует ссылку на событие для проверки с PostBackOptions.Registers an event reference for validation with PostBackOptions.

RegisterForEventValidation(String)

Регистрирует ссылку на событие для проверки с уникальным ИД элемента управления, представляющим клиентский элемент управления, генерирующий событие.Registers an event reference for validation with a unique control ID representing the client control generating the event.

RegisterForEventValidation(String, String)

Регистрирует ссылку на событие для проверки с уникальным ИД элемента управления, представляющим клиентский элемент управления, генерирующий событие, и аргументами события.Registers an event reference for validation with a unique control ID and event arguments representing the client control generating the event.

RegisterHiddenField(String, String)

Регистрирует скрытое значение с объектом Page.Registers a hidden value with the Page object.

RegisterOnSubmitStatement(Type, String, String)

Регистрирует оператор OnSubmit с объектом Page, используя тип, ключ и константу скрипта.Registers an OnSubmit statement with the Page object using a type, a key, and a script literal. Оператор выполняется, если HtmlForm представляется на рассмотрение.The statement executes when the HtmlForm is submitted.

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.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
ValidateEvent(String)

Проверяет клиентское событие, зарегистрированное для проверки, используя метод RegisterForEventValidation(String).Validates a client event that was registered for event validation using the RegisterForEventValidation(String) method.

ValidateEvent(String, String)

Проверяет клиентское событие, зарегистрированное для проверки, используя метод RegisterForEventValidation(String, String).Validates a client event that was registered for event validation using the RegisterForEventValidation(String, String) method.

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

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