PersonalizationAdministration.GetAllState メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
要求されたパーソナル化スコープとその他の指定されたパラメーターについて、基になるデータ ストアからすべてのパーソナル化状態情報のコレクションを返します。
オーバーロード
| 名前 | 説明 |
|---|---|
| GetAllState(PersonalizationScope) |
要求されたパーソナル化スコープの基になるデータ ストアから、すべてのパーソナル化状態情報のコレクションを返します。 |
| GetAllState(PersonalizationScope, Int32, Int32, Int32) |
指定したパラメーターに基づいて、基になるデータ ストアからすべてのパーソナル化状態情報のサブセットを返します。 |
GetAllState(PersonalizationScope)
要求されたパーソナル化スコープの基になるデータ ストアから、すべてのパーソナル化状態情報のコレクションを返します。
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ GetAllState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection GetAllState(System.Web.UI.WebControls.WebParts.PersonalizationScope scope);
static member GetAllState : System.Web.UI.WebControls.WebParts.PersonalizationScope -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function GetAllState (scope As PersonalizationScope) As PersonalizationStateInfoCollection
パラメーター
- scope
- PersonalizationScope
取得するパーソナル化情報のスコープ。
返品
指定したスコープの状態情報を含む PersonalizationStateInfoCollection 。
例外
構成で定義されているパーソナル化プロバイダーのプロバイダーが正しい型ではありません。
構成済みのパーソナル化プロバイダーのインスタンスを作成および初期化しようとしたときに、構成例外が発生しました。
-又は-
構成で定義されている既定のパーソナル化プロバイダーが見つかりませんでした。
scope は、 PersonalizationScope 列挙型の有効なメンバーではありません。
注釈
返されるコレクションには、PersonalizationStateInfo型またはSharedPersonalizationStateInfo型のいずれかのUserPersonalizationStateInfo派生オブジェクトのみが含まれていることに注意してください。 既定のパーソナル化プロバイダーを使用すると、 PersonalizationStateInfo派生オブジェクトはアルファベット順に返され、パスとユーザー名の組み合わせで昇順に並べ替えられます。 コレクション内のオブジェクトの順序は、プロバイダーによって決まります。
こちらもご覧ください
- WebPartPersonalization
- ASP.NET Web パーツ コントロール
- Web パーツのパーソナル化の概要
- チュートリアル: ユーザー コントロールを使用した Web パーツのパーソナル化の実装
- Web パーツのパーソナル化
適用対象
GetAllState(PersonalizationScope, Int32, Int32, Int32)
指定したパラメーターに基づいて、基になるデータ ストアからすべてのパーソナル化状態情報のサブセットを返します。
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ GetAllState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection GetAllState(System.Web.UI.WebControls.WebParts.PersonalizationScope scope, int pageIndex, int pageSize, out int totalRecords);
static member GetAllState : System.Web.UI.WebControls.WebParts.PersonalizationScope * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function GetAllState (scope As PersonalizationScope, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection
パラメーター
- scope
- PersonalizationScope
取得するパーソナル化情報のスコープ。
- pageIndex
- Int32
返される結果のページの 0 から始まるインデックス。
- pageSize
- Int32
返すレコードの数。
- totalRecords
- Int32
使用可能なレコードの合計数。
返品
指定したスコープとパラメーターの状態情報を含む PersonalizationStateInfoCollection 。
例外
pageIndex が 0 未満です。
-又は-
pageSize が 0 以下です。
-又は-
構成で定義されているパーソナル化プロバイダーのプロバイダーが正しい型ではありません。
-又は-
pageIndexとpageSizeの組み合わせが Int32.MaxValue を超えています。
scope は、 PersonalizationScope 列挙型の有効なメンバーではありません。
構成済みのパーソナル化プロバイダーのインスタンスを作成および初期化しようとしたときに、構成例外が発生しました。
-又は-
構成で定義されている既定のパーソナル化プロバイダーが見つかりませんでした。
注釈
返されるコレクション内の項目は主にスコープに基づいており、そのスコープに対応するレコードは、 pageIndex および pageSize パラメーターに基づいてサブセットにさらに縮小されます。 返されるコレクションには、 SharedPersonalizationStateInfo インスタンスのみが含まれるか、インスタンスのみが UserPersonalizationStateInfo されます。
返される項目は、 pageIndex パラメーターと pageSize パラメーターによって制限されます。ここで、 pageIndex は返すレコードを制御し、 pageSize は返されるレコードの数を制御します。 たとえば、 pageIndex が 0 に設定され、 pageSize が 25 に設定されている場合、返されるデータは最初の 25 エントリになります。
pageIndexが 1 に設定され、pageSizeが 25 に設定されている場合、返されるデータはエントリ 26 から 50 になります。
totalRecords パラメーターは、使用可能なレコードの合計数を返します。
既定のパーソナル化プロバイダーを使用すると、 PersonalizationStateInfo派生オブジェクトはアルファベット順に返され、パスとユーザー名の組み合わせで昇順に並べ替えられます。 コレクション内のオブジェクトの順序は、プロバイダーによって決まります。
こちらもご覧ください
- WebPartPersonalization
- ASP.NET Web パーツ コントロール
- Web パーツのパーソナル化の概要
- チュートリアル: ユーザー コントロールを使用した Web パーツのパーソナル化の実装
- Web パーツのパーソナル化