WebPartPersonalization::ChangeScope Method (PersonalizationScope)

 

Changes the current page's PersonalizationScope instance to the scope specified.

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

protected:
virtual void ChangeScope(
	PersonalizationScope scope
)

Parameters

scope
Type: System.Web.UI.WebControls.WebParts::PersonalizationScope

The new personalization scope for the current page.

Exception Condition
InvalidOperationException

If attempting to switch from User scope to Shared scope, the current user does not have the user capability to enter Shared scope.

ArgumentOutOfRangeException

scope is not a valid member of the PersonalizationScope enumeration.

This method changes the currently executing page's personalization scope to the new scope specified by the newScope parameter. This method is the protected helper method that is called by the public ToggleScope method. This protected method exists to handle future extensibility if there are more than two possible scopes to switch between.

If the current scope and newScope are the same value, then this method performs no operation.

.NET Framework
Available since 2.0
Return to top
Show: