This documentation is archived and is not being maintained.

WebPartPersonalization::ExtractPersonalizationState Method (WebPart)

Extracts personalization data from a Web Parts control when requested to do so by the parent WebPartManager control.

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

protected public:
virtual void ExtractPersonalizationState(
	WebPart^ webPart
)

Parameters

webPart
Type: System.Web.UI.WebControls.WebParts::WebPart

The Web Parts control containing personalization data to be extracted.

ExceptionCondition
ArgumentException

An attempt was made to extract personalization state from a Web Parts control that is not managed by the parent WebPartManager.

InvalidOperationException

An attempt was made to extract personalization state prior to the state being loaded from the underlying data store.

- or -

Personalization state has not been applied yet.

- or -

The ID of the WebPart has changed since personalization data was applied.

- or -

The personalization state returned from the data store was nullptr.

If the IsEnabled property is set to true, and personalization state is not being reset during the page request (such as when the ShouldResetPersonalizationState property is false), then this method extracts personalization data from the Web Parts control specified by webPart. This method calls the ExtractWebPartPersonalization method on the PersonalizationState instance to extract personalization state from the supplied Web Parts control.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: