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

Note

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

Эта перегрузка RegisterClientScriptInclude метода вызывает перегрузку, которая принимает параметр, а keyURLтакже параметр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 укажите тип.

Note

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

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

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

Обратная связь

Были ли сведения на этой странице полезными?

ClientScriptManager.RegisterClientScriptInclude Метод

Определение

Перегрузки

RegisterClientScriptInclude(String, String)

Параметры

Примеры

Комментарии

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

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

RegisterClientScriptInclude(Type, String, String)

Параметры

Исключения

Примеры

Комментарии

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

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