This documentation is archived and is not being maintained.

WebPartManager::SaveCustomPersonalizationState Method

Saves custom personalization state data maintained by the WebPartManager control, so that this data can be reloaded whenever the page is reloaded.

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

protected:
virtual void SaveCustomPersonalizationState(
	PersonalizationDictionary^ state
)

Parameters

state
Type: System.Web.UI.WebControls.WebParts::PersonalizationDictionary
A PersonalizationDictionary that contains the state data to be loaded.

The SaveCustomPersonalizationState method is critical in the process of personalization, because it enables personalized user settings to be stored for future browser sessions and visits to a page. The method saves custom personalization state data, which includes items such as the following: dynamic WebPart or server controls that have been added to a page or deleted from a page; controls that have been moved on a page; and dynamic connections that have been created or deleted.

You cannot call this method directly from your code. You can, however, call the IPersonalizable::Save method, which itself calls this method to save personalization data.

Notes to Inheritors

Developers can override this method in a derived WebPartManager class to customize the process of saving personalization data.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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