WebPartPersonalization.CopyPersonalizationState Method (WebPart, WebPart)

 
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.

Extracts the personalization state from one Web Parts control and applies it to a second Web Parts control.

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

protected internal virtual void CopyPersonalizationState(
	WebPart webPartA,
	WebPart webPartB
)

Parameters

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

The Web Parts control supplying the personalization data.

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

The Web Parts control receiving the personalization data.

Exception Condition
ArgumentNullException

Either webPartA or webPartB is null.

ArgumentException

webPartA and webPartB are not of the same Type.

- or -

webPartA and webPartB are GenericWebPart controls but one or both lack a child control.

- or -

webPartA and webPartB are GenericWebPart controls, but their child controls are not of the same Type.

This method extracts the personalization state from webPartA and applies it to webPartB. This method assumes that webPartA and webPartB are the same type. If the Web Parts controls are GenericWebPart controls, the method copies the personalization state from the child control wrapped in webPartA to the child control wrapped in webPartB.

As part of the copy operation, webPartB is marked as "dirty".

.NET Framework
Available since 2.0
Return to top
Show: