WebPartUserCapability Class

  • Reference

Definition

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

Provides information about a user's capabilities to view and modify personalization data. This class cannot be inherited.

public ref class WebPartUserCapability sealed
public sealed class WebPartUserCapability
type WebPartUserCapability = class
Public NotInheritable Class WebPartUserCapability
Inheritance
Object
WebPartUserCapability

Remarks

At various points in the life cycle of a Web Parts application, the WebPartPersonalization object needs to check the capabilities of the current user to determine what personalization data the user can view and modify. When this need arises, the personalization object checks instances of the WebPartUserCapability class.

The Web Parts personalization feature defines two user capabilities, each of which is represented by a WebPartUserCapability object. Both of these objects have corresponding verbs that can be used to specify user capabilities within the <authorization> section of a Web.config file. For more information, see authorization Element for personalization for webParts (ASP.NET Settings Schema). The different user capabilities are shown in the following table.

User capability Description
modifyState Indicates that the current user can save personalization data to the data store. Accessed through the ModifyStateUserCapability field on a WebPartPersonalization object.
enterSharedScope Indicates that the current user can enter Shared personalization scope. Accessed through the EnterSharedScopeUserCapability field on a WebPartPersonalization object.

The WebPartUserCapability class has one public property. The Name property indicates the name of the class.

The WebPartUserCapability class also has two exposed methods. The Equals method allows two user capability objects to be compared. The objects are considered equal if they have the same name. The GetHashCode method generates a hash code based on the name of the WebPartUserCapability object.

Constructors

WebPartUserCapability(String)

Initializes a new instance of the class.

Properties

Name

Gets a string value identifying the class.

Methods

Equals(Object)

Determines whether the specified object is equal to the current WebPartUserCapability object, or has the same Name value.
GetHashCode()

Returns the hash code for the Name property.
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also