PersonalizationProvider.DetermineUserCapabilities(WebPartManager) Method

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Returns a dictionary containing WebPartUserCapability instances that represent the personalization-related capabilities of the currently executing user account.

public:
 virtual System::Collections::IDictionary ^ DetermineUserCapabilities(System::Web::UI::WebControls::WebParts::WebPartManager ^ webPartManager);

public virtual System.Collections.IDictionary DetermineUserCapabilities (System.Web.UI.WebControls.WebParts.WebPartManager webPartManager);

abstract member DetermineUserCapabilities : System.Web.UI.WebControls.WebParts.WebPartManager -> System.Collections.IDictionary
override this.DetermineUserCapabilities : System.Web.UI.WebControls.WebParts.WebPartManager -> System.Collections.IDictionary

Public Overridable Function DetermineUserCapabilities (webPartManager As WebPartManager) As IDictionary

Parameters

webPartManager

WebPartManager

The WebPartManager managing the personalization information.

Returns

IDictionary

An IDictionary containing zero or more WebPartUserCapability instances if the user account is authenticated, or null if the executing user account is not authenticated.

Exceptions

ArgumentException

The page associated with webPartManager is null.

-or-

The request associated with the page is null.

ArgumentNullException

webPartManager is null.

Remarks

The default implementation of this method consumes the information in the authorization Element for personalization for webParts (ASP.NET Settings Schema) element within the personalization Element for webParts (ASP.NET Settings Schema) element of the webParts Element (ASP.NET Settings Schema) configuration section in the Machine.config or Web.config file to determine a user's authorized capabilities.

The capabilities in the dictionary will be members of the IList object returned by the CreateSupportedUserCapabilities method, which currently include the EnterSharedScopeUserCapability capability and the ModifyStateUserCapability capability.