PersonalizationProvider.SavePersonalizationState(PersonalizationState) 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.

Saves personalization data to a data store.

public:
 virtual void SavePersonalizationState(System::Web::UI::WebControls::WebParts::PersonalizationState ^ state);

public virtual void SavePersonalizationState (System.Web.UI.WebControls.WebParts.PersonalizationState state);

abstract member SavePersonalizationState : System.Web.UI.WebControls.WebParts.PersonalizationState -> unit
override this.SavePersonalizationState : System.Web.UI.WebControls.WebParts.PersonalizationState -> unit

Public Overridable Sub SavePersonalizationState (state As PersonalizationState)

Parameters

state: PersonalizationState

A PersonalizationState containing personalization data to be saved.

Exceptions

ArgumentNullException

state is null.

ArgumentException

The state object being saved has a different type from the state object that was returned by the LoadPersonalizationState(WebPartManager, Boolean) method.

Remarks

This method is the main entry point used by the WebPartPersonalization class to save personalization data.

The default implementation of this method uses the methods of an internal implementation of PersonalizationState to pack personalization data into a byte array. If the results of this packing create an empty byte array (because property extraction resulted in no personalization data), the default implementation calls the ResetPersonalizationBlob method. Otherwise, the default implementation calls the SavePersonalizationBlob method.

Applies to