WebPartPersonalization.ApplyPersonalizationState Method

  • Reference

Definition

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

Applies personalization data to either a WebPartManager control associated with the WebPartPersonalization instance, or to a specific WebPart instance.

Overloads

ApplyPersonalizationState()

Applies personalization data to the parent WebPartManager control.
ApplyPersonalizationState(WebPart)

Applies personalization data to the specified WebPart control when requested to do so by the parent WebPartManager control.

ApplyPersonalizationState()

Applies personalization data to the parent WebPartManager control.

protected public:
 virtual void ApplyPersonalizationState();
protected internal virtual void ApplyPersonalizationState ();
abstract member ApplyPersonalizationState : unit -> unit
override this.ApplyPersonalizationState : unit -> unit
Protected Friend Overridable Sub ApplyPersonalizationState ()

Exceptions

InvalidOperationException

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

-or-

The personalization state returned from the data store was null.

Remarks

If the IsEnabled property is set to true, this method calls the ApplyWebPartPersonalization method on the PersonalizationState instance to apply personalization state to the supplied Web Parts control.

See also

Applies to

ApplyPersonalizationState(WebPart)

Applies personalization data to the specified WebPart control when requested to do so by the parent WebPartManager control.

protected public:
 virtual void ApplyPersonalizationState(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);
protected internal virtual void ApplyPersonalizationState (System.Web.UI.WebControls.WebParts.WebPart webPart);
abstract member ApplyPersonalizationState : System.Web.UI.WebControls.WebParts.WebPart -> unit
override this.ApplyPersonalizationState : System.Web.UI.WebControls.WebParts.WebPart -> unit
Protected Friend Overridable Sub ApplyPersonalizationState (webPart As WebPart)

Parameters

webPart
WebPart

The Web Parts control to which personalization data is to be applied.

Exceptions

ArgumentException

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

ArgumentNullException

webPart is null.

InvalidOperationException

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

-or-

The personalization state returned from the data store was null.

-or-

An attempt was made to apply personalization data more than once to the same Web Parts control.

Remarks

This method is called to apply personalization data to an individual WebPart-derived class when requested to do so by the parent WebPartManager control.

If the IsEnabled property is set to true, this method calls the ApplyWebPartPersonalization method on the PersonalizationState instance to apply personalization state to the supplied Web Parts control.

See also

Applies to