Substitution クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Substitution クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

出力キャッシュを使用する Web ページのうち、キャッシュしないセクションを指定します。この位置で、動的なコンテンツが取得され、Substitution コントロールで置き換えられます。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Class Substitution
    Inherits Control

Visual Basic (使用法)

Dim instance As Substitution

public class Substitution : Control

C++

public ref class Substitution : public
 Control

public class Substitution extends Control

JScript

public class Substitution extends
 Control

解説

Substitution コントロールを使用して、出力キャッシュを使用する Web ページのうち、コントロールを動的なコンテンツで置き換えるセクションを指定します。Substitution コントロールは、ほとんどのコンテンツがキャッシュされるページに対して、部分ページキャッシュを行うよりシンプルなソリューションを提供します。ページ全体を出力キャッシュしてから、Substitution コントロールを使用して、キャッシュしないページ部分を指定できます。キャッシュされる領域は一度だけ実行され、キャッシュエントリの有効期限が切れるかパージされるまで再生されます。動的領域はページが要求されるたびに実行されます。このキャッシュモデルでは、セクションをカプセル化して Web ユーザーコントロールにキャッシュする必要がないため、本来は静的であるページのコードが簡略化されています。たとえば、ニュース記事などの静的コンテンツと、広告を表示する AdRotator コントロールを含むページの場合は、このキャッシュモデルを使用すると便利です。ニュース記事は変更されないのでキャッシュできます。ただし、ユーザーがページを要求するたびに、新しい広告を表示したいとします。AdRotator コントロールはキャッシュ後の置き換えを直接サポートするため、ページがキャッシュされているかどうかにかかわらず、ページがポストバックされるたびに新しい広告を表示します。

メモ
Substitution コントロールは、キャッシュされるページに含まれるユーザーコントロール内に配置できます。ただし、Substitution コントロールを出力キャッシュされるユーザーコントロール内に配置することはできません。

Substitution コントロールは、実行時に文字列を返すメソッドを呼び出します。このメソッドが返す文字列の内容が、ページ上の Substitution コントロールの位置に表示されます。MethodName プロパティを使用して、Substitution コントロールの実行時に呼び出すコールバックメソッドの名前を指定します。指定するコールバックメソッドは、ページ上または Substitution コントロールを格納しているユーザーコントロールの静的メソッドであることが必要です。コールバックメソッドのシグネチャは、HttpContext パラメータを受け取って文字列を返す HttpResponseSubstitutionCallback デリゲートのシグネチャと一致する必要があります。

ページの出力キャッシュを操作するために、@ OutputCache ディレクティブ、HttpCachePolicy クラス、または Cache プロパティを使用できます。ページのキャッシュの詳細については、「ASP.NET ページのキャッシュ」および「ASP.NET ページの一部だけのキャッシュ」を参照してください。

Substitution コントロールを使用する代わりに、HttpResponseSubstitutionCallback デリゲートを使用して、キャッシュの置き換え動作を取得することもできます。また、この機能を直接サポートするコントロール (AdRotator コントロールなど) のキャッシュの置き換え動作を取得することもできます。詳細については、「キャッシュページの動的な部分更新」を参照してください。

使用例

Substitution コントロールを出力キャッシュを使用する Web ページに宣言によって追加する方法のコード例を次に示します。ページが読み込まれると、ユーザーに対して現在の日付と時刻がラベルに表示されます。ページのこのセクションはキャッシュされ、60 秒ごとに更新されます。Substitution コントロールは、実行時に GetCurrentDateTime メソッドを呼び出します。GetCurrentDateTime から返される文字列がユーザーに表示されます。ページのこのセクションはキャッシュされず、ページの表示が更新されるたびに更新されます。

Visual Basic

<%@ outputcache duration="60" varybyparam="none"
 %>
<script runat="server" language="VB">
  
  
  Sub Page_Load(ByVal sender As
 Object, ByVal e As System.EventArgs)
    ' Display the current date and time in the label.
    ' Output caching applies to this section of the page.
    CachedDateLabel.Text = DateTime.Now.ToString()
  End Sub
  
  ' The Substitution control calls this method to retrieve
  ' the current date and time. This section of the page
  ' is exempt from output caching. 
  Shared Function GetCurrentDateTime(ByVal
 context As HttpContext) As String
    Return DateTime.Now.ToString()
  End Function
  
</script>

<html>
<head id="Head1" runat="server">
  <title>Substitution Class Example</title>
</head>
<body>
  <form id="Form1" runat="server">
  
    <h3>Substitution Class Example</h3>  
    
    <p>This section of the page is not
 cached:</p>
    
    <asp:substitution id="Substitution1"
      methodname="GetCurrentDateTime"
      runat="Server">
    </asp:substitution>
    
    <br />
    
    <p>This section of the page is cached:</p>
    
    <asp:label id="CachedDateLabel"
      runat="Server">
    </asp:label>
    
    <br /><br />
    
    <asp:button id="RefreshButton"
      text="Refresh Page"
      runat="Server">
    </asp:button>     

  </form>
</body>
</html>

<%@ outputcache duration="60" varybyparam="none" %>
<script runat="server" language="C#">  
  
  void Page_Load(object sender, System.EventArgs e)
  {
    // Display the current date and time in the label.
    // Output caching applies to this section of the page.
    CachedDateLabel.Text = DateTime.Now.ToString();    
  }
  
  // The Substitution control calls this method to retrieve
  // the current date and time. This section of the page
  // is exempt from output caching. 
  public static string GetCurrentDateTime
 (HttpContext context)
  {
    return DateTime.Now.ToString ();
  }
  
</script>

<html>
<head runat="server">
  <title>Substitution Class Example</title>
</head>
<body>
  <form runat="server">
  
    <h3>Substitution Class Example</h3>  
    
    <p>This section of the page is not cached:</p>
    
    <asp:substitution id="Substitution1"
      methodname="GetCurrentDateTime"
      runat="Server">
    </asp:substitution>
    
    <br />
    
    <p>This section of the page is cached:</p>
    
    <asp:label id="CachedDateLabel"
      runat="Server">
    </asp:label>
    
    <br /><br />
    
    <asp:button id="RefreshButton"
      text="Refresh Page"
      runat="Server">
    </asp:button>     

  </form>
</body>
</html>