Export (0) Print
Expand All

WebPartUserCapability Class

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

System.Object
  System.Web.UI.WebControls.WebParts.WebPartUserCapability

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

public sealed class WebPartUserCapability

The WebPartUserCapability type exposes the following members.

  NameDescription
Public methodWebPartUserCapabilityInitializes a new instance of the class.
Top

  NameDescription
Public propertyNameGets a string value identifying the class.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current WebPartUserCapability object, or has the same Name value. (Overrides Object.Equals(Object).)
Public methodGetHashCodeReturns the hash code for the Name property. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft