ControlCachePolicy

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

ControlCachePolicy クラス

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

ASP.NET ユーザー コントロールの出力キャッシュ設定に対する、プログラムによるアクセス手段を提供します。

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

Visual Basic (宣言)

Public NotInheritable Class
 ControlCachePolicy

Visual Basic (使用法)

Dim instance As ControlCachePolicy

C#

public sealed class ControlCachePolicy

C++

public ref class ControlCachePolicy sealed

J#

public final class ControlCachePolicy

JScript

public final class ControlCachePolicy

解説

ControlCachePolicy クラスは、ユーザー コントロールのプログラムを作成するときに、ユーザー コントロール (.ascx ファイル) の出力キャッシュ設定を指定するために開発者が使用します。ASP.NET では、ユーザー コントロールは BasePartialCachingControl インスタンス内に埋め込まれます。BasePartialCachingControl クラスは、出力キャッシュが有効になったユーザー コントロールを表すクラスです。PartialCachingControl コントロールの BasePartialCachingControl.CachePolicy プロパティにアクセスすると、有効な ControlCachePolicy オブジェクトをいつでも受け取ることができます。ただし、UserControl コントロールの UserControl.CachePolicy プロパティにアクセスする場合は、ユーザー コントロールが既に BasePartialCachingControl コントロールによってラップされている場合しか、有効な ControlCachePolicy オブジェクトを受け取ることはできません。ユーザー コントロールがラップされていない場合は、プロパティから返された ControlCachePolicy オブジェクトを操作しようとすると例外がスローされます。これは、このオブジェクトに関連付けられた BasePartialCachingControl が存在しないためです。UserControl インスタンスでキャッシュがサポートされているかどうかを、例外を生成せずに判断するには、SupportsCaching プロパティを調べます。

出力キャッシュを有効にできる方法の 1 つは、ControlCachePolicy クラスを使用することです。出力キャッシュを有効にするために使用できる方法は、次のとおりです。

• ディレクティブによって出力キャッシュを有効にする場合は、@ OutputCache ディレクティブを使用します。

• 分離コード ファイルのユーザー コントロールのキャッシュを有効にするには、PartialCachingAttribute 属性を使用します。

• プログラム内で、既に説明したいずれかのメソッドでキャッシュを有効にし、System.Web.UI.TemplateControl.LoadControl メソッドによって動的に読み込んだ BasePartialCachingControl インスタンスを使用している場合、そのプログラムからキャッシュ設定を指定するには、ControlCachePolicy クラスを使用します。ControlCachePolicy インスタンスを正常に操作できるのは、コントロールの有効期間のうち Init 段階から PreRender 段階までの間のみです。PreRender 段階よりも後で ControlCachePolicy オブジェクトに変更を加えると、ASP.NET から例外がスローされます。コントロールが表示された後で加えられた変更は、実際にはキャッシュの設定に反映されないためです (コントロールは Render 段階でキャッシュされます)。最後に、ユーザー コントロールのインスタンス (つまり ControlCachePolicy オブジェクト) が実際に表示された後は、プログラムでしかそのインスタンスを操作できません。

使用例

実行時にプログラムからユーザー コントロールを動的に読み込み、操作する方法を次のコード例に示します。PartialCachingAttribute 属性が SimpleControl というユーザー コントロールに適用されます。これは、ユーザー コントロールが実行時に PartialCachingControl コントロールによってラップされることを意味します。SimpleControl オブジェクトのキャッシュ設定は、関連付けられた ControlCachePolicy オブジェクト (このオブジェクトをラップする PartialCachingControl コントロールへの参照を使用してアクセス可能) を通じてプログラムから操作できます。この例では、ページの初期化中に Duration プロパティを調べ、いくつかの条件を満たした場合、SetSlidingExpiration メソッドと SetExpires メソッドを使用して変更を加えます。

Visual Basic

<%@ Page Language="VB" %>
<%@ Reference Control="SimpleControl.ascx" %>
<script language="VB" runat="server">

    ' The following example demonstrates how to load a user control
 dynamically at run time, and
    ' work with the ControlCachePolicy object associated with it.

    ' Loads and displays a UserControl defined in a seperate Logonform.ascx
 file.
    ' You need to have "SimpleControl.ascx" file in 
    ' the same directory as the aspx file. 

    Sub Page_Init(ByVal sender As
 Object, ByVal e As System.EventArgs)
    
        ' Obtain a PartialCachingControl object which wraps the 'LogOnControl'
 user control.
        Dim pcc As PartialCachingControl
        pcc = LoadControl("SimpleControl.ascx")
    
        ' If the control is slated to expire in greater than 60 Seconds
        If (pcc.CachePolicy.Duration > TimeSpan.FromSeconds(60))
 Then
            ' Make it expire faster. Set a new expiration time to 30
 seconds, and make it
            ' an absolute expiration if it isnt already.        
            pcc.CachePolicy.SetExpires(DateTime.Now.Add(TimeSpan.FromSeconds(30)))
            pcc.CachePolicy.SetSlidingExpiration(False)
        End If
        Controls.Add(pcc)
    End Sub
</script>

C#

<%@ Page Language="C#" %>
<%@ Reference Control="SimpleControl.ascx" %>
<script language="C#" runat="server">

// The following example demonstrates how to load a user control dynamically
 at run time, and
// work with the ControlCachePolicy object associated with it.

// Loads and displays a UserControl defined in a seperate Logonform.ascx
 file.
// You need to have "SimpleControl.ascx" file in 
// the same directory as the aspx file. 

void Page_Init(object sender, System.EventArgs e) {
    
    // Obtain a PartialCachingControl object which wraps the 'LogOnControl'
 user control.
    PartialCachingControl pcc = LoadControl("SimpleControl.ascx") as PartialCachingControl;
        
    
    // If the control is slated to expire in greater than 60 Seconds
    if (pcc.CachePolicy.Duration > TimeSpan.FromSeconds(60)
 ) 
    {        
        // Make it expire faster. Set a new expiration time to 30 seconds,
 and make it
        // an absolute expiration if it isnt already.        
        pcc.CachePolicy.SetExpires(DateTime.Now.Add(TimeSpan.FromSeconds(30)));
        pcc.CachePolicy.SetSlidingExpiration(false);
    }                    
    Controls.Add(pcc);
}
</script>

Web フォーム ページから SimpleControl ユーザー コントロールを使用する方法を次のコード例に示します。この例を正常に実行するには、ユーザー コントロール ファイル (.ascx)、それに対応する分離コード ファイル (.cs または .vb)、およびそのユーザー コントロール (.aspx) をホストする Web フォーム ページが同じディレクトリ内にあることを確認してください。

Visual Basic

Imports System.Data.SqlClient

Partial Class SimpleControl
    Inherits System.Web.UI.UserControl

    Protected Sub Page_Load(ByVal
 sender As Object, ByVal
 e As EventArgs)
        ItemsRemaining.Text = GetAvailableItems().ToString()
        CacheTime.Text = DateTime.Now.ToLongTimeString()
    End Sub

    Private Function GetAvailableItems() As
 Integer
        Dim sqlConnection As SqlConnection
        Dim sqlCommand As SqlCommand
        Dim items As Integer

        sqlConnection = New SqlConnection("Initial
 Catalog=Northwind;Data Source=localhost;Integrated Security=SSPI;")
        sqlCommand = sqlConnection.CreateCommand()
        sqlCommand.CommandType = Data.CommandType.StoredProcedure
        sqlCommand.CommandText = "GetRemainingItems"
        sqlConnection.Open()
        items = CInt(sqlCommand.ExecuteScalar())
        sqlConnection.Close()
        Return items
    End Function
End Class

C#

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
using System.Data.SqlClient;

[PartialCaching(100)]
public partial class SimpleControl : System.Web.UI.UserControl
{    
    protected void Page_Load(object sender,
 EventArgs e)
    {
        ItemsRemaining.Text = GetAvailableItems().ToString();
        CacheTime.Text = DateTime.Now.ToLongTimeString();
    }

    private int GetAvailableItems()
    {
        SqlConnection sqlConnection = new SqlConnection
            ("Initial Catalog=Northwind;Data Source=localhost;Integrated Security=SSPI;");
        SqlCommand sqlCommand = sqlConnection.CreateCommand();
        sqlCommand.CommandType = CommandType.StoredProcedure;
        sqlCommand.CommandText = "GetRemainingItems";
        sqlConnection.Open();
        int items = (int)sqlCommand.ExecuteScalar();
        sqlConnection.Close();
        return items;
    }
}

Visual Basic

<%@ Control Language="VB" AutoEventWireup="true"
 CodeFile="SimpleControl.ascx.vb" Inherits="SimpleControl"
 %>
<form>
<table cellspacing=15>
<tr>
<td><b>Available items: </b></td>
<td>
    <asp:Label ID="ItemsRemaining" runat="server"
 Text="Label"></asp:Label>
</td>
</tr>
<tr>
<td><b>As of: </b></td>
<td>
    <asp:Label ID="CacheTime" runat="server"
 Text="Label"></asp:Label>
</td>
</tr>
</table>
</form>

C#

<%@ Control Language="C#" AutoEventWireup="true"
 CodeFile="SimpleControl.ascx.cs" Inherits="SimpleControl" %>
<form>
<table cellspacing=15>
<tr>
<td><b>Available items: </b></td>
<td>
    <asp:Label ID="ItemsRemaining" runat="server" Text="Label"></asp:Label>
</td>
</tr>
<tr>
<td><b>As of: </b></td>
<td>
    <asp:Label ID="CacheTime" runat="server" Text="Label"></asp:Label>
</td>
</tr>
</table>
</form>

継承階層

System.Object
  System.Web.UI.ControlCachePolicy

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ControlCachePolicy メンバ
System.Web.UI 名前空間
BasePartialCachingControl.CachePolicy プロパティ
UserControl.CachePolicy
その他の技術情報
@ OutputCache
ASP.NET ページの一部だけのキャッシュ

ControlCachePolicy プロパティ

パブリック プロパティ

	名前	説明
	Cached	ユーザー コントロールに対してフラグメント キャッシュが有効かどうかを示す値を取得または設定します。
	Dependency	キャッシュされたユーザー コントロール出力に関連付けられた CacheDependency クラスのインスタンスを取得または設定します。
	Duration	キャッシュされたアイテムが出力キャッシュ内に存続する時間を取得または設定します。
	SupportsCaching	ユーザー コントロールがキャッシュをサポートしているかどうかを示す値を取得します。
	VaryByControl	キャッシュされた出力の変更に使用するコントロール ID のリストを取得または設定します。
	VaryByParams	キャッシュされた出力の変更に使用する GET パラメータ名または POST パラメータ名のリストを取得または設定します。

参照

関連項目

ControlCachePolicy クラス
System.Web.UI 名前空間
BasePartialCachingControl.CachePolicy プロパティ
UserControl.CachePolicy

その他の技術情報

@ OutputCache
ASP.NET ページの一部だけのキャッシュ

ControlCachePolicy メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	SetExpires	ユーザー コントロールをラップする BasePartialCachingControl コントロールに対して、指定された日時にキャッシュ エントリの有効期限が切れるように指示します。
	SetSlidingExpiration	ユーザー コントロールをラップする BasePartialCachingControl コントロールに対して、ユーザー コントロールのキャッシュ エントリで変化する有効期限または絶対有効期限が使用されるように設定するよう指示します。
	SetVaryByCustom	出力キャッシュがユーザー コントロールを変更するために使用するカスタム文字列のリストを設定します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ControlCachePolicy クラス
System.Web.UI 名前空間
BasePartialCachingControl.CachePolicy プロパティ
UserControl.CachePolicy

その他の技術情報

@ OutputCache
ASP.NET ページの一部だけのキャッシュ

ControlCachePolicy メンバ

ASP.NET ユーザー コントロールの出力キャッシュ設定に対する、プログラムによるアクセス手段を提供します。

ControlCachePolicy データ型で公開されるメンバを以下の表に示します。

パブリック プロパティ

	名前	説明
	Cached	ユーザー コントロールに対してフラグメント キャッシュが有効かどうかを示す値を取得または設定します。
	Dependency	キャッシュされたユーザー コントロール出力に関連付けられた CacheDependency クラスのインスタンスを取得または設定します。
	Duration	キャッシュされたアイテムが出力キャッシュ内に存続する時間を取得または設定します。
	SupportsCaching	ユーザー コントロールがキャッシュをサポートしているかどうかを示す値を取得します。
	VaryByControl	キャッシュされた出力の変更に使用するコントロール ID のリストを取得または設定します。
	VaryByParams	キャッシュされた出力の変更に使用する GET パラメータ名または POST パラメータ名のリストを取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	SetExpires	ユーザー コントロールをラップする BasePartialCachingControl コントロールに対して、指定された日時にキャッシュ エントリの有効期限が切れるように指示します。
	SetSlidingExpiration	ユーザー コントロールをラップする BasePartialCachingControl コントロールに対して、ユーザー コントロールのキャッシュ エントリで変化する有効期限または絶対有効期限が使用されるように設定するよう指示します。
	SetVaryByCustom	出力キャッシュがユーザー コントロールを変更するために使用するカスタム文字列のリストを設定します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ControlCachePolicy クラス
System.Web.UI 名前空間
BasePartialCachingControl.CachePolicy プロパティ
UserControl.CachePolicy

その他の技術情報

@ OutputCache
ASP.NET ページの一部だけのキャッシュ