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 列挙体のメンバーではありません。
注釈
返されるコレクションには、 型または 型SharedPersonalizationStateInfoのいずれかの派生オブジェクトのみがPersonalizationStateInfo含まれていることに注意してください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 以下です。
- または -
構成でパーソナル化プロバイダーに対して定義されたプロバイダーの種類が正しくありません。
- または -
と の組み合わせが Int32.MaxValue を超えています。pageIndex
pageSize
scope
が有効な PersonalizationScope 列挙体のメンバーではありません。
構成されたパーソナル化プロバイダーのインスタンスを作成し、初期化しようとした際に、構成の例外が発生しました。
- または -
構成で定義された既定のパーソナル化プロバイダーが見つかりません。
注釈
返されるコレクション内の項目は主にスコープに基づいており、そのスコープに対応するレコードは、 パラメーターと pageSize
パラメーターに基づいてサブセットにpageIndex
さらに縮小されます。 返されるコレクションには、 SharedPersonalizationStateInfo インスタンスのみ、または UserPersonalizationStateInfo インスタンスのみが含まれます。
返される項目は、 パラメーターと pageSize
パラメーターによってpageIndex
制限されます。ここでpageIndex
、返すレコードを制御し、pageSize
返されるレコードの数を制御します。 たとえば、 が 0 に設定され、pageSize
25 に設定されている場合pageIndex
、返されるデータは最初の 25 エントリになります。 が 1 に設定され、pageSize
25 に設定されている場合pageIndex
、返されるデータはエントリ 26 から 50 になります。 パラメーターは totalRecords
、使用可能なレコードの合計数を返します。
既定のパーソナル化プロバイダーを PersonalizationStateInfo使用すると、派生オブジェクトはアルファベット順に返され、パスとユーザー名の組み合わせで昇順で並べ替えられます。 コレクション内のオブジェクトの順序は、プロバイダーによって決まります。
こちらもご覧ください
- WebPartPersonalization
- ASP.NET Web パーツ コントロール
- Web パーツの個人用設定の概要
- チュートリアル: ユーザー コントロールを使用した Web パーツの個人用設定の実装
- Web パーツの個人用設定
適用対象
.NET