ClientScriptManager.RegisterClientScriptInclude Метод

  • Ссылка

Определение

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

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

Перегрузки

RegisterClientScriptInclude(String, String)

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

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

RegisterClientScriptInclude(String, String)

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

public:
 void RegisterClientScriptInclude(System::String ^ key, System::String ^ url);
public void RegisterClientScriptInclude (string key, string url);
member this.RegisterClientScriptInclude : string * string -> unit
Public Sub RegisterClientScriptInclude (key As String, url As String)

Параметры

key
String

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

url
String

URL-адрес регистрируемого включения клиентского скрипта.

Примеры

Дополнительные сведения, включая синтаксис, использование и пример, см. в разделе RegisterClientScriptInclude.

Комментарии

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

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

Примечание

Чтобы разрешить URL-адрес клиента, используйте ResolveClientUrl метод. Этот метод использует контекст URL-адреса, в котором он вызывается для разрешения пути.

Эта перегрузка RegisterClientScriptInclude метода вызывает перегрузку, которая принимает параметр key, а URLтакже параметр type .

Этот метод добавляет блок скрипта в верхней части отрисоченной страницы.

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

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

RegisterClientScriptInclude(Type, String, String)

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

public:
 void RegisterClientScriptInclude(Type ^ type, System::String ^ key, System::String ^ url);
public void RegisterClientScriptInclude (Type type, string key, string url);
member this.RegisterClientScriptInclude : Type * string * string -> unit
Public Sub RegisterClientScriptInclude (type As Type, key As String, url As String)

Параметры

type
Type

Тип регистрируемого включения клиентского скрипта.

key
String

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

url
String

URL-адрес регистрируемого включения клиентского скрипта.

Исключения

ArgumentNullException

Тип включения клиентского скрипта — null.

ArgumentException

Введите URL-адрес null.

-или- URL пуст.

Примеры

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

<%@ 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, type and url of the client script on the page.
        String csname = "ButtonClickScript";
        String csurl = "~/script_include.js";
        Type cstype = this.GetType();

        // Get a ClientScriptManager reference from the Page class.
        ClientScriptManager cs = Page.ClientScript;

        // Check to see if the include script exists already.
        if (!cs.IsClientScriptIncludeRegistered(cstype, csname))
        {
            cs.RegisterClientScriptInclude(cstype, csname, ResolveClientUrl(csurl));
        }

    }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1" runat="server">
     <div>
        <input type="text"
               id="Message"/> 
        <input type="button" 
               value="ClickMe"
               onclick="DoClick()"/>
     </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">
    
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

        ' Define the name, type and url of the client script on the page.
        Dim csname As String = "ButtonClickScript"
        Dim csurl As String = "~/script_include.js"
        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 include script is already registered.
        If (Not cs.IsClientScriptIncludeRegistered(cstype, csname)) Then
      
            cs.RegisterClientScriptInclude(cstype, csname, ResolveClientUrl(csurl))
      
        End If
    
    End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
     <form id="Form1" runat="server">
     <div>
        <input type="text"
               id="Message"/> 
        <input type="button" 
               value="ClickMe"
               onclick="DoClick()"/>
     </div>
     </form>
</body>
</html>

В этом примере требуется файл JavaScript с именем Script_include.js со следующим содержимым:

function DoClick() {Form1.Message.value='Text from include script.'}

Комментарии

Эта перегрузка RegisterClientScriptInclude метода принимает параметры ключа и URL-адреса для идентификации скрипта, а также type параметр для указания идентификации клиентского скрипта. Укажите тип на основе объекта, который будет обращаться к ресурсу. Например, при использовании экземпляра Page для доступа к ресурсу Page указывается тип.

Примечание

Чтобы разрешить URL-адрес клиента, используйте ResolveClientUrl метод. Этот метод использует контекст URL-адреса, в котором он вызывается для разрешения пути.

Этот метод добавляет блок скрипта в верхней части отрисоченной страницы.

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

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