Edit

Share via

PersonalizationAdministration.GetAllState Method

Definition

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Returns a collection of all personalization state information from the underlying data store for the requested personalization scope and other specified parameters.

Overloads

GetAllState(PersonalizationScope)

Returns a collection of all personalization state information from the underlying data store for the requested personalization scope.
GetAllState(PersonalizationScope, Int32, Int32, Int32)

Returns a subset of all personalization state information from the underlying data store, based on the specified parameters.

GetAllState(PersonalizationScope)

Returns a collection of all personalization state information from the underlying data store for the requested personalization scope.

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

Parameters

scope
PersonalizationScope

The scope of the personalization information to be retrieved.

Returns

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection containing state information for the specified scope.

Exceptions

ArgumentException

The provider for a personalization provider defined in configuration is not of the correct type.

ConfigurationErrorsException

A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.

-or-

The default personalization provider defined in configuration could not be found.

ArgumentOutOfRangeException

scope is not a valid member of the PersonalizationScope enumeration.

Remarks

Note that the returned collection contains only PersonalizationStateInfo-derived objects of either type SharedPersonalizationStateInfo or type UserPersonalizationStateInfo. Using the default personalization provider, the PersonalizationStateInfo-derived objects are returned in alphabetical order, and sorted by a combination of path and user name in ascending order. The order of the objects in the collection is determined by the provider.

See also

Applies to

GetAllState(PersonalizationScope, Int32, Int32, Int32)

Returns a subset of all personalization state information from the underlying data store, based on the specified parameters.

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

Parameters

scope
PersonalizationScope

The scope of the personalization information to be retrieved.

pageIndex
Int32

The zero-based index of the page of results to return.

pageSize
Int32

The number of records to return.

totalRecords
Int32

The total number of records available.

Returns

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection containing state information for the specified scope and parameters.

Exceptions

ArgumentException

pageIndex is less than zero.

-or-

pageSize is less than or equal to zero.

-or-

The provider for a personalization provider defined in configuration is not of the correct type.

-or-

The combination of pageIndex and pageSize exceeds Int32.MaxValue.

ArgumentOutOfRangeException

scope is not a valid member of the PersonalizationScope enumeration.

ConfigurationErrorsException

A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.

-or-

The default personalization provider defined in configuration could not be found.

Remarks

The items in the collection returned are based primarily on scope, and then the records corresponding to that scope are further reduced to a subset based on the pageIndex and pageSize parameters. The collection returned contains either SharedPersonalizationStateInfo instances only, or UserPersonalizationStateInfo instances only.

The items returned are constrained by the pageIndex and pageSize parameters, where pageIndex controls which records to return and pageSize controls the number of records returned. For example, if pageIndex was set to 0 and pageSize was set to 25, the data returned would be the first 25 entries. If pageIndex was set to 1 and pageSize was set to 25, the data returned would be entries 26 to 50. The totalRecords parameter returns the total number of records that are available.

Using the default personalization provider, the PersonalizationStateInfo-derived objects are returned in alphabetical order, and sorted by a combination of path and user name in ascending order. The order of the objects in the collection is determined by the provider.

See also

Applies to