WebPartManager.IPersonalizable.Load(PersonalizationDictionary) Method

Reference

Definition

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

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns previously saved custom personalization state data that needs to be loaded to the WebPartManager control.

 virtual void System.Web.UI.WebControls.WebParts.IPersonalizable.Load(System::Web::UI::WebControls::WebParts::PersonalizationDictionary ^ state) = System::Web::UI::WebControls::WebParts::IPersonalizable::Load;

void IPersonalizable.Load (System.Web.UI.WebControls.WebParts.PersonalizationDictionary state);

abstract member System.Web.UI.WebControls.WebParts.IPersonalizable.Load : System.Web.UI.WebControls.WebParts.PersonalizationDictionary -> unit
override this.System.Web.UI.WebControls.WebParts.IPersonalizable.Load : System.Web.UI.WebControls.WebParts.PersonalizationDictionary -> unit

Sub Load (state As PersonalizationDictionary) Implements IPersonalizable.Load

Parameters

state: PersonalizationDictionary

A PersonalizationDictionary that contains the state data to be loaded.

Implements

Load(PersonalizationDictionary)

Remarks

This method is an implementation of the IPersonalizable.Load method, which provides a way for the Web Parts control set to directly access the protected WebPartManager.LoadCustomPersonalizationState method. When this method is called, it stores the custom personalized data that is managed by the WebPartManager control, and that was previously saved in the permanent data store for use later in the initialization process.

Note

In most cases, page and control developer code does not need to call this method, because it is primarily used by the Web Parts control set as its mechanism for retrieving personalization data.

Notes to Inheritors

One scenario in which developers would use this method is if they are developing a custom personalization framework to use in place of the one provided by the Web Parts control set. In such cases, developers could inherit from the WebPartManager class and override the CreatePersonalization() method to return a custom implementation of a WebPartPersonalization object. The custom WebPartPersonalization object would call the implementation of the IPersonalizable.Load(PersonalizationDictionary) method at the proper time to load custom personalization data.

Applies to

Share via