次の方法で共有

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 示しています。 既存のスタートアップ スクリプト ブロックをチェックするロジックが削除された場合、メソッドによって重複がチェックされるため RegisterStartupScript 、レンダリングされたページの HTML ソース コードに 2 つの重複するスタートアップ スクリプトは存在しないことに注意してください。 チェックの利点は、不要な計算を減らすことです。

<%@ 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 呼び出します。

こちらもご覧ください

適用対象