WebPartManager.SaveCustomPersonalizationState Method

Definition

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

protected:
 virtual void SaveCustomPersonalizationState(System::Web::UI::WebControls::WebParts::PersonalizationDictionary ^ state);
protected virtual void SaveCustomPersonalizationState (System.Web.UI.WebControls.WebParts.PersonalizationDictionary state);
abstract member SaveCustomPersonalizationState : System.Web.UI.WebControls.WebParts.PersonalizationDictionary -> unit
override this.SaveCustomPersonalizationState : System.Web.UI.WebControls.WebParts.PersonalizationDictionary -> unit
Protected Overridable Sub SaveCustomPersonalizationState (state As PersonalizationDictionary)

Parameters

state
PersonalizationDictionary

A PersonalizationDictionary that contains the state data to be loaded.

Remarks

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.

Applies to

See also