WebPartPersonalization.InitialScope Property

Reference

Definition

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

Assembly:: System.Web.dll

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.

Gets or sets the default personalization scope.

public:
 virtual property System::Web::UI::WebControls::WebParts::PersonalizationScope InitialScope { System::Web::UI::WebControls::WebParts::PersonalizationScope get(); void set(System::Web::UI::WebControls::WebParts::PersonalizationScope value); };

public virtual System.Web.UI.WebControls.WebParts.PersonalizationScope InitialScope { get; set; }

member this.InitialScope : System.Web.UI.WebControls.WebParts.PersonalizationScope with get, set

Public Overridable Property InitialScope As PersonalizationScope

Property Value

PersonalizationScope

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

Exceptions

InvalidOperationException

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

ArgumentOutOfRangeException

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

Remarks

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.

Applies to

Jaa