This documentation is archived and is not being maintained.

WebPartsPersonalization Class

Allows you to specify the personalization provider and set personalization authorizations. This class cannot be inherited.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

'Declaration
Public NotInheritable Class WebPartsPersonalization _
	Inherits ConfigurationElement
'Usage
Dim instance As WebPartsPersonalization

WebPartsPersonalization provides configuration support for personalization options for Web Parts, such as the personalization provider and personalization authorizations.

This example demonstrates how to specify values declaratively for several attributes of the webParts section, which can also be accessed as members of the WebPartsPersonalization class.

The following configuration file example shows how to specify values declaratively for the webParts section.

<system.web>
  <webParts>
    <personalization
      defaultProvider="AspNetSqlPersonalizationProvider">
        <!—- Providers may only be defined at the 
            application level -->
      <providers>
         <add name="AspNetSqlPersonalizationProvider"
type="System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider"
            connectionStringName="LocalSqlServer"
            applicationName="/" />      
      </providers>
      <authorization>
        <deny users="*" verbs="enterSharedScope" />
        <allow users="*" verbs="modifyState" />
      </authorization>
    </personalization>
  </webParts> 
</system.web>

The following code example demonstrates how to use the WebPartsPersonalization class.

This code example is part of a larger example provided for the WebPartsSection class.

' Get the current DefaultProvider property value.
Console.WriteLine( _
  "Current DefaultProvider value: '{0}'", _
  webPartsSection.Personalization.DefaultProvider)

' Set the DefaultProvider property.
webPartsSection.Personalization.DefaultProvider = _
  "ASPNetSQLPersonalizationProvider" 
' Add a provider.
webPartsSection.Personalization.Providers.Add( _
  New ProviderSettings("CustomProvider", _
  "MyCustomProviders.Provider"))

' List current providers. 
Dim pi As Integer 
For pi = 0 To webPartsSection.Personalization.Providers.Count - 1
  Console.WriteLine("  #{0} Name={1} Type={2}", pi, _
    webPartsSection.Personalization.Providers(pi).Name, _
    webPartsSection.Personalization.Providers(pi).Type)
Next 

' Add an authorization. 
Dim ar As AuthorizationRule = _
  New AuthorizationRule(AuthorizationRuleAction.Allow)
ar.Verbs.Add("ModifyState")
ar.Users.Add("Admin")
webPartsSection.Personalization.Authorization.Rules.Add(ar)

' List current authorizations. 
Dim ai As Integer 
For ai = 0 To _
  webPartsSection.Personalization.Authorization.Rules.Count
	Console.WriteLine("  #{0}:", ai)
    Dim aRule As AuthorizationRule = _
      webPartsSection.Personalization.Authorization.Rules(ai)
    Console.WriteLine("  Verbs=")
    Dim verb As String 
    For Each verb In aRule.Verbs
      Console.WriteLine("    * {0}", verb)
      Console.WriteLine("  Roles=")
    Next 
    Dim role As String 
	For Each role In aRule.Roles
      Console.WriteLine("    * {0}", role)
      Console.WriteLine("  Users=")
    Next 
    Dim user As String 
	For Each user In aRule.Users
      Console.WriteLine("    * {0}", user)
    Next 
Next

System.Object
  System.Configuration.ConfigurationElement
    System.Web.Configuration.WebPartsPersonalization

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: