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 对象

另请参阅

适用于