ClientScriptManager.IsStartupScriptRegistered Метод

  • Ссылка

Определение

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

Определяет, зарегистрирован ли скрипт, активизируемый при запуске, с объектом Page.

Перегрузки

IsStartupScriptRegistered(Type, String)

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

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

IsStartupScriptRegistered(Type, String)

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

public:
 bool IsStartupScriptRegistered(Type ^ type, System::String ^ key);
public bool IsStartupScriptRegistered (Type type, string key);
member this.IsStartupScriptRegistered : Type * string -> bool
Public Function IsStartupScriptRegistered (type As Type, key As String) As Boolean

Параметры

type
Type

Тип скрипта запуска, используемый при поиске.

key
String

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

Возвращаемое значение

Boolean

true, если скрипт, активизируемый при запуске, зарегистрирован; в противном случае — false.

Исключения

ArgumentNullException

Тип скрипта, активизируемого при запуске, — null.

Примеры

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

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

Комментарии

Вызовите этот метод перед вызовом RegisterStartupScript метода, чтобы избежать регистрации повторяющихся скриптов. Это особенно важно, если скрипту требуется большой объем ресурсов сервера для создания.

Скрипт запуска клиента однозначно определяется его ключом и типом. Скрипты с одним и тем же ключом и типом считаются дубликатами.

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

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

IsStartupScriptRegistered(String)

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

public:
 bool IsStartupScriptRegistered(System::String ^ key);
public bool IsStartupScriptRegistered (string key);
member this.IsStartupScriptRegistered : string -> bool
Public Function IsStartupScriptRegistered (key As String) As Boolean

Параметры

key
String

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

Возвращаемое значение

Boolean

true, если скрипт, активизируемый при запуске, зарегистрирован; в противном случае — false.

Комментарии

Вызовите этот метод перед вызовом RegisterStartupScript метода, чтобы избежать регистрации повторяющихся скриптов. Это особенно важно, если скрипту требуется большой объем ресурсов сервера для создания.

Скрипт запуска однозначно определяется его ключом и типом. Скрипты с одним и тем же ключом и типом считаются дубликатами.

Эта перегрузка IsStartupScriptRegistered метода вызывает перегрузку, которая принимает как строку key , так и type параметр с набором Page типов в качестве объекта.

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

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