ClientScriptManager.IsClientScriptIncludeRegistered メソッド

  • リファレンス

定義

名前空間:
System.Web.UI
アセンブリ:
System.Web.dll

クライアント スクリプト インクルードが Page オブジェクトに登録されているかどうかを判断します。

オーバーロード

IsClientScriptIncludeRegistered(String)

指定されたキーを使用して、クライアント スクリプト インクルードが Page オブジェクトに登録されているかどうかを判断します。
IsClientScriptIncludeRegistered(Type, String)

キーと型を使用して、クライアント スクリプト インクルードが Page オブジェクトに登録されているかどうかを判断します。

IsClientScriptIncludeRegistered(String)

指定されたキーを使用して、クライアント スクリプト インクルードが Page オブジェクトに登録されているかどうかを判断します。

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

パラメーター

key
String

検索対象のクライアント スクリプト インクルードのキー。

戻り値

Boolean

クライアント スクリプト インクルードが登録されている場合は true。それ以外の場合は false。

注釈

重複するスクリプトを登録しないように、メソッドを RegisterClientScriptInclude 呼び出す前にこのメソッドを呼び出します。 これは、スクリプトで大量のサーバー リソースを作成する必要がある場合に特に重要です。

クライアント スクリプト インクルードは、キーとその型によって一意に識別されます。 同じキーと型を持つスクリプトは重複と見なされます。

このメソッドのオーバーロードは、 IsStartupScriptRegistered 型がオブジェクトとして設定された a key とパラメーターの両方を type 受け取るオーバーロードを Page 呼び出します。

こちらもご覧ください

適用対象

IsClientScriptIncludeRegistered(Type, String)

キーと型を使用して、クライアント スクリプト インクルードが Page オブジェクトに登録されているかどうかを判断します。

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

パラメーター

type
Type

検索対象のクライアント スクリプト インクルードの型。

key
String

検索対象のクライアント スクリプト インクルードのキー。

戻り値

Boolean

クライアント スクリプト インクルードが登録されている場合は true。それ以外の場合は false。

例外

ArgumentNullException

クライアント スクリプト インクルードの型が null です。

例

次のコード例では、このメソッドの使用方法を IsClientScriptIncludeRegistered 示します。 既存のクライアント スクリプトインクルードをチェックするロジックが削除された場合、メソッドは重複をチェックするため、レンダリングされたページの HTML ソース コードに 2 つの重複するクライアント スクリプトは存在しないことに 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 呼び出す前にこのメソッドを呼び出します。 これは、スクリプトで大量のサーバー リソースを作成する必要がある場合に特に重要です。

クライアント スクリプト インクルードは、キーとその型によって一意に識別されます。 同じキーと型を持つスクリプトは重複と見なされます。 リソースにアクセスするオブジェクトに基づいて型を指定します。 たとえば、Page インスタンスを使用してリソースにアクセスする場合は、型を Page 指定します。

こちらもご覧ください

適用対象