PersonalizationProvider.LoadPersonalizationState Method

Note: This method is new in the .NET Framework version 2.0.

Loads the raw data from the underlying data store and converts that data into a PersonalizationState object.

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in system.web.dll)

public:
virtual PersonalizationState^ LoadPersonalizationState (
	WebPartManager^ webPartManager, 
	bool ignoreCurrentUser
)
public PersonalizationState LoadPersonalizationState (
	WebPartManager webPartManager, 
	boolean ignoreCurrentUser
)
public function LoadPersonalizationState (
	webPartManager : WebPartManager, 
	ignoreCurrentUser : boolean
) : PersonalizationState

Parameters

webPartManager

The WebPartManager managing the personalization data.

ignoreCurrentUser

A Boolean indicating whether the user name should be passed to the personalization provider.

Return Value

A PersonalizationState containing personalization data.

Exception typeCondition

ArgumentNullException

The webPartManager is a null reference (Nothing in Visual Basic).

ArgumentException

The page associated with webPartManager is a null reference (Nothing in Visual Basic).

- or -

The request associated with the page is a null reference (Nothing in Visual Basic).

This method is the main entry point used by the WebPartPersonalization class to load personalization data. The default implementation loads the raw data from the underlying data store (functionality is implemented in derived providers) and then converts the raw data into a PersonalizationState instance.

If the ignoreCurrentUser parameter is true, no user name is passed to the LoadPersonalizationBlobs method. A personalization provider can choose to interpret this as meaning that only personalization state with a Shared scope should be retrieved from the underlying data store.

When the Load method is executing, it calls the LoadPersonalizationState method, and there are three types of deserialization errors that can occur as the state is being loaded. When these specific errors occur, no exception is thrown, and the error events are logged instead by the Health Monitoring feature (for information on health monitoring and accessing the logs created by it, see ASP.NET Health Monitoring). Following are the three scenarios that cause deserialization error events to be written to the log.

  • A failed attempt to deserialize a property type that uses a string TypeConverter.

  • A failed attempt to deserialize a property type that uses binary serialization.

  • A failed attempt to deserialize a property type because an instance of the type cannot be created.

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: