WebPartPersonalization.InitialScope Property

 
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.

Gets or sets the default personalization scope.

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

public virtual PersonalizationScope InitialScope { get; set; }

Property Value

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

The PersonalizationScope indicating the default personalization scope of the associated WebPartManager.

Exception Condition
InvalidOperationException

An attempt was made to set this property to a value other than its current value after the associated WebPartManager control's OnInit method had completed.

ArgumentOutOfRangeException

An attempt was made to set a value of InitialScope that is not a member of the PersonalizationScope enumeration.

This property represents the default personalization scope that should be used for the parent WebPartManager control in the absence of previous knowledge about the proper scope. If this property is not explicitly set, it defaults to returning User scope.

This property can only be set prior to the completion of the WebPartManager control's OnInit method. In practice, this means InitialScope must be set in the page markup on the WebPartManager element. Alternatively, this property can be set during the PreInit phase of the WebPartManager control.

.NET Framework
Available since 2.0
Return to top
Show: