WebPartPersonalization.ResetPersonalizationState Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Resets personalization data for the current page, scope, and user in the underlying data store.

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

public virtual void ResetPersonalizationState()

Exception Condition
InvalidOperationException

An attempt was made to reset personalization data when the current user is not authorized to modify personalization state.

- or -

The Page instance for the associated WebPartManager is null.

- or -

The value of the Request property on the WebPartManager control's associated Page instance is null.

InvalidOperationException

The WebPartPersonalization instance cannot reference a valid personalization provider.

This method resets personalization data for the current page, scope, and user in the underlying data store. As a side effect of the reset, the currently executing page is re-executed by a Transfer call. Note that this transfer re-executes the current page as a GET request regardless of how the page was originally requested.

This method can be called at any time. Internally, this method calls the ResetPersonalizationState method on the provider. After data is successfully reset, the ShouldResetPersonalizationState property is set to true. This property is used elsewhere by the WebPartPersonalization instance to bypass extracting personalization data from control properties and saving it if data has already been reset.

.NET Framework
Available since 2.0
Return to top
Show: