WebPartPersonalization.ExtractPersonalizationState Method
Definition
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.
Extracts personalization data from the parent WebPartManager control.
Overloads
ExtractPersonalizationState() |
Extracts personalization data from the parent WebPartManager control. |
ExtractPersonalizationState(WebPart) |
Extracts personalization data from a Web Parts control when requested to do so by the parent WebPartManager control. |
ExtractPersonalizationState()
Extracts personalization data from the parent WebPartManager control.
protected public:
virtual void ExtractPersonalizationState();
protected internal virtual void ExtractPersonalizationState ();
abstract member ExtractPersonalizationState : unit -> unit
override this.ExtractPersonalizationState : unit -> unit
Protected Friend Overridable Sub ExtractPersonalizationState ()
Exceptions
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 WebPartManager has changed since personalization data was applied.
-or-
The personalization state returned from the data store was null
.
Remarks
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 parent WebPartManager control during its SaveStateComplete event.
This method calls the ExtractWebPartManagerPersonalization method on the PersonalizationState instance to extract personalization state from the parent WebPartManager control.
See also
- WebPartManager
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization
Applies to
ExtractPersonalizationState(WebPart)
Extracts personalization data from a Web Parts control when requested to do so by the parent WebPartManager control.
protected public:
virtual void ExtractPersonalizationState(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);
protected internal virtual void ExtractPersonalizationState (System.Web.UI.WebControls.WebParts.WebPart webPart);
abstract member ExtractPersonalizationState : System.Web.UI.WebControls.WebParts.WebPart -> unit
override this.ExtractPersonalizationState : System.Web.UI.WebControls.WebParts.WebPart -> unit
Protected Friend Overridable Sub ExtractPersonalizationState (webPart As WebPart)
Parameters
- webPart
- WebPart
The Web Parts control containing personalization data to be extracted.
Exceptions
An attempt was made to extract personalization state from a Web Parts control that is not managed by the parent WebPartManager.
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 null
.
Remarks
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.
See also
- WebPartManager
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization