ClientScriptManager.RegisterClientScriptInclude Метод

Определение

Регистрирует включение клиентского скрипта с объектом Page.Registers the client script include with the Page object.

Перегрузки

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.

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.

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

Ключ регистрируемого включения клиентского скрипта.The key of the client script include to register.

url
String

URL-адрес регистрируемого включения клиентского скрипта.The URL of the client script include to register.

Примеры

Связанные сведения, в том числе синтаксис, использование и пример, см. RegisterClientScriptIncludeв разделе.For related information, including syntax, usage, and an example, see RegisterClientScriptInclude.

Комментарии

Включение клиентского скрипта однозначно идентифицируется по ключу и типу.A client script include 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.

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

Примечание

Чтобы разрешить URL-адрес клиента, используйте ResolveClientUrl метод.To resolve the client URL, use the ResolveClientUrl method. Этот метод использует контекст URL-адреса, по которому он вызывается для разрешения пути.This method uses the context of the URL on which it is called to resolve the path.

Эта перегрузка RegisterClientScriptInclude метода вызывает перегрузку, которая keyпринимает type , URLи параметр.This overload of the RegisterClientScriptInclude method calls the overload that takes a key, a URL, and a type parameter.

Метод добавляет блок скрипта в верхней части отображаемой страницы.The method adds a script block at the top of the rendered page.

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

RegisterClientScriptInclude(Type, String, String)

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

Параметры

type
Type

Тип регистрируемого включения клиентского скрипта.The type of the client script include to register.

key
String

Ключ регистрируемого включения клиентского скрипта.The key of the client script include to register.

url
String

URL-адрес регистрируемого включения клиентского скрипта.The URL of the client script include to register.

Исключения

Тип включения клиентского скрипта — null.The client script include type is null.

URL-адрес имеет значение null.The URL is null.

- или --or- URL пуст.The URL is empty.

Примеры

В следующем примере кода показано использование RegisterClientScriptInclude метода.The following code example demonstrates the use of the RegisterClientScriptInclude method. Обратите внимание, что если логика для проверки существующих клиентских скриптов была удалена, на странице, подготовленной для просмотра, по-прежнему не будет RegisterClientScriptInclude повторяющихся клиентских скриптов, так как метод проверяет наличие дубликатов.Note that if the logic to check for the existing client script include were removed, there would still not be duplicate client scripts in the rendered page because the RegisterClientScriptInclude method checks for duplicates. Преимущество проверки заключается в сокращении числа ненужных вычислений.The benefit of checking is to reduce unnecessary computation.

<%@ 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 со следующим содержимым:This example requires a JavaScript file named Script_include.js with the following contents:

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

Комментарии

Эта перегрузка RegisterClientScriptInclude метода принимает параметры ключа и URL-адреса для идентификации type скрипта, а также параметр для указания кода включения клиентского скрипта.This overload of the RegisterClientScriptInclude method takes key and url parameters to identify the script, as well as a type parameter to specify the identification of the client script include. Тип указывается на основе объекта, который будет обращаться к ресурсу.You specify the type based on the object that will be accessing the resource. Например, при использовании Page экземпляра для доступа к ресурсу необходимо Page указать тип.For instance, when using a Page instance to access the resource, you specify the Page type.

Примечание

Чтобы разрешить URL-адрес клиента, используйте ResolveClientUrl метод.To resolve the client URL, use the ResolveClientUrl method. Этот метод использует контекст URL-адреса, по которому он вызывается для разрешения пути.This method uses the context of the URL on which it is called to resolve the path.

Этот метод добавляет блок скрипта в верхней части отображаемой страницы.This method adds a script block at the top of the rendered page.

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

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