PersonalizationProvider

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

PersonalizationProvider クラス

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

パーソナル化プロバイダの基本機能を実装します。

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

Visual Basic (宣言)

Public MustInherit Class
 PersonalizationProvider
    Inherits ProviderBase

Visual Basic (使用法)

Dim instance As PersonalizationProvider

C#

public abstract class PersonalizationProvider
 : ProviderBase

C++

public ref class PersonalizationProvider abstract
 : public ProviderBase

J#

public abstract class PersonalizationProvider
 extends ProviderBase

JScript

public abstract class PersonalizationProvider
 extends ProviderBase

解説

これは、パーソナル化プロバイダに必要な機能を定義する抽象基本クラスです。パーソナル化プロバイダは、WebPartPersonalization インスタンスに代わってパーソナル化データの読み込みと格納を行います。

この基本クラスでは多くのメソッドの標準的な動作が定義されます。基になるデータ ストアを具体的に扱うメソッドだけが抽象メソッドに指定されています。これにより開発者は、WebPartPersonalization クラスで使用される標準機能を再実装することなく、特定のデータ ストアと対話するカスタム プロバイダを作成できます。

継承時の注意 PersonalizationProvider から派生して、このクラスで定義された抽象メソッドだけに実装を提供できます。抽象メソッドは、特に、物理的なデータ ストアとの間のデータの保存と読み込みと、データ ストアの管理に関係しています。カスタム プロバイダは、Shared データと User データを区別するパーソナル化情報を操作できる必要があります。また、プロバイダは、パーソナル化データをページおよびアプリケーションによって区別する必要があります。 一部のパーソナル化プロバイダのメソッドは PersonalizationState 派生クラスのインスタンスを返すため、PersonalizationProvider の実装は PersonalizationState の実装と密に結合されています。カスタム プロバイダの開発を容易にするため、PersonalizationProvider 基本クラスには、パーソナル化ロジックの既定の実装と WebPartPersonalization クラスによって直接使用されるシリアル化/逆シリアル化のロジックが含まれています。そのため、単に異なるデータ ストアを使用する目的で作成するカスタム プロバイダには、次の抽象メソッド以外は実装する必要がありません。

• GetCountOfState : このメソッドでは、指定したクエリ パラメータで、データベース内のパーソナル化データの行数をカウントできる必要があります。

• LoadPersonalizationBlobs : このメソッドは、パスおよびユーザー名を与えられると、データベースから 2 つの BLOB を読み込みます。1 つは共有データの BLOB で、もう 1 つはユーザー データの BLOB です。ユーザー名およびパスを指定した場合、ユーザー名とパスの情報が提供されるページ情報に WebPartManager コントロールでアクセスする必要はありません。

• ResetPersonalizationBlob : このメソッドは、パスおよびユーザー名を与えられると、データベース内の対応する行を削除します。ユーザー名およびパスを指定した場合、ユーザー名とパスの情報が提供されるページ情報に WebPartManager コントロールでアクセスする必要はありません。

• SavePersonalizationBlob : このメソッドは、パスおよびユーザー名を与えられると、指定された BLOB をデータベースに保存します。ユーザー名およびパスを指定した場合、ユーザー名とパスの情報が提供されるページ情報に WebPartManager コントロールでアクセスする必要はありません。

これらのすべてのメソッドで、パスだけが指定される場合は、ページの共有パーソナル化データが有効になっていることを示します。パスとユーザー名の両方がメソッドに渡される場合は、ページのユーザー パーソナル化データが有効にされる必要があります。LoadPersonalizationBlobs の場合、常に、指定したパスの共有データが読み込まれます。また、ユーザー名が null 参照 (Visual Basic では Nothing) でない場合には、必要に応じて、そのパスのユーザー パーソナル化データも読み込まれます。 その他のすべての抽象メソッドは、管理アプリケーションのみで使用されるように設計されており、実行時に Web パーツのインフラストラクチャで使用されることはありません。パーソナル化プロバイダの実装例については、SqlPersonalizationProvider クラスのトピックを参照してください。

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Configuration.Provider.ProviderBase
    System.Web.UI.WebControls.WebParts.PersonalizationProvider
       System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
PersonalizationProvider メンバ
System.Web.UI.WebControls.WebParts 名前空間
SqlPersonalizationProvider
その他の技術情報
ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化

PersonalizationProvider コンストラクタ

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

PersonalizationProvider クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New PersonalizationProvider

C#

protected PersonalizationProvider ()

C++

protected:
PersonalizationProvider ()

J#

protected PersonalizationProvider ()

JScript

protected function PersonalizationProvider
 ()

解説

これは抽象クラスのコンストラクタであるため、このメソッドをオーバーライドして、このクラスから継承したクラスのインスタンスを作成する必要があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
PersonalizationProvider クラス
PersonalizationProvider メンバ
System.Web.UI.WebControls.WebParts 名前空間

PersonalizationProvider プロパティ

パブリック プロパティ

	名前	説明
	ApplicationName	派生クラスでオーバーライドされると、プロバイダに対して構成されたアプリケーションの名前を取得または設定します。
	Description	管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 ( ProviderBase から継承されます。)
	Name	構成時にプロバイダを参照するために使用される表示名を取得します。 ( ProviderBase から継承されます。)

参照

関連項目

PersonalizationProvider クラス
System.Web.UI.WebControls.WebParts 名前空間
SqlPersonalizationProvider

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化

PersonalizationProvider メソッド

パブリック メソッド

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

	名前	説明
	DetermineInitialScope	初期パーソナル化スコープが、Shared スコープと User スコープのどちらであるかを判断します。
	DetermineUserCapabilities	現在実行中のユーザー アカウントのパーソナル化関連機能を表す WebPartUserCapability のインスタンスが含まれているディクショナリを返します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	FindState	派生クラスでオーバーライドされると、スコープおよび固有のクエリ パラメータに基づき 0 個以上の PersonalizationStateInfo 派生オブジェクトが含まれているコレクションを返します。
	GetCountOfState	派生クラスでオーバーライドされると、指定したスコープ内に存在する基になるデータ ストア内の行数を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	Initialize	プロバイダを初期化します。 ( ProviderBase から継承されます。)
	LoadPersonalizationState	基になるデータ ストアから生のデータを読み込み、そのデータを PersonalizationState オブジェクトに変換します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ResetPersonalizationState	パーソナル化データを基になるデータ ストアの状態にリセットします。
	ResetState	派生クラス内でオーバーライドされると、指定したパラメータに基づいて、基になるデータ ストアからパーソナル化状態が削除されます。
	ResetUserState	派生クラス内でオーバーライドされると、指定したパラメータに基づいて、Web パーツ パーソナル化データが基になるデータ ストアから削除されます。
	SavePersonalizationState	パーソナル化データをデータ ストアに保存します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	CreateSupportedUserCapabilities	Web パーツ コントロール セットによって使用される一連の既知の機能を表す WebPartUserCapability オブジェクトのリストを返します。
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	LoadPersonalizationBlobs	派生クラス内でオーバーライドされると、基になるデータ ストアから生のパーソナル化データを読み込みます。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	ResetPersonalizationBlob	派生クラス内でオーバーライドされると、基になるデータ ストアから生のパーソナル化データを削除します。
	SavePersonalizationBlob	派生クラス内でオーバーライドされると、基になるデータ ストアに生のパーソナル化データを保存します。

参照

関連項目

PersonalizationProvider クラス
System.Web.UI.WebControls.WebParts 名前空間
SqlPersonalizationProvider

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化

PersonalizationProvider メンバ

パーソナル化プロバイダの基本機能を実装します。

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

プロテクト コンストラクタ

	名前	説明
	PersonalizationProvider	PersonalizationProvider クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	ApplicationName	派生クラスでオーバーライドされると、プロバイダに対して構成されたアプリケーションの名前を取得または設定します。
	Description	管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。(ProviderBase から継承されます。)
	Name	構成時にプロバイダを参照するために使用される表示名を取得します。(ProviderBase から継承されます。)

パブリック メソッド

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

	名前	説明
	DetermineInitialScope	初期パーソナル化スコープが、Shared スコープと User スコープのどちらであるかを判断します。
	DetermineUserCapabilities	現在実行中のユーザー アカウントのパーソナル化関連機能を表す WebPartUserCapability のインスタンスが含まれているディクショナリを返します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	FindState	派生クラスでオーバーライドされると、スコープおよび固有のクエリ パラメータに基づき 0 個以上の PersonalizationStateInfo 派生オブジェクトが含まれているコレクションを返します。
	GetCountOfState	派生クラスでオーバーライドされると、指定したスコープ内に存在する基になるデータ ストア内の行数を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	Initialize	プロバイダを初期化します。 (ProviderBase から継承されます。)
	LoadPersonalizationState	基になるデータ ストアから生のデータを読み込み、そのデータを PersonalizationState オブジェクトに変換します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ResetPersonalizationState	パーソナル化データを基になるデータ ストアの状態にリセットします。
	ResetState	派生クラス内でオーバーライドされると、指定したパラメータに基づいて、基になるデータ ストアからパーソナル化状態が削除されます。
	ResetUserState	派生クラス内でオーバーライドされると、指定したパラメータに基づいて、Web パーツ パーソナル化データが基になるデータ ストアから削除されます。
	SavePersonalizationState	パーソナル化データをデータ ストアに保存します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	CreateSupportedUserCapabilities	Web パーツ コントロール セットによって使用される一連の既知の機能を表す WebPartUserCapability オブジェクトのリストを返します。
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	LoadPersonalizationBlobs	派生クラス内でオーバーライドされると、基になるデータ ストアから生のパーソナル化データを読み込みます。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	ResetPersonalizationBlob	派生クラス内でオーバーライドされると、基になるデータ ストアから生のパーソナル化データを削除します。
	SavePersonalizationBlob	派生クラス内でオーバーライドされると、基になるデータ ストアに生のパーソナル化データを保存します。

参照

関連項目

PersonalizationProvider クラス
System.Web.UI.WebControls.WebParts 名前空間
SqlPersonalizationProvider

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化