Export (0) Print
Expand All

WebPartsPersonalization Class

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

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

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

public sealed class WebPartsPersonalization : ConfigurationElement

The WebPartsPersonalization type exposes the following members.

  NameDescription
Public methodWebPartsPersonalizationInfrastructure. Initializes a new instance of the WebPartsPersonalization class using default settings.
Top

  NameDescription
Public propertyAuthorizationGets an AuthorizationSection object containing the Web Parts personalization authorizations for the current Web application.
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyDefaultProviderGets or sets the name of the default Web Parts personalization provider.
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyProvidersGets a ProviderSettingsCollection collection that contains the Web Parts personalization providers for the current Web application.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

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. 
for (int pi = 0; 
	pi < webPartsSection.Personalization.Providers.Count; pi++)
{
	Console.WriteLine("  #{0} Name={1} Type={2}", pi,
		webPartsSection.Personalization.Providers[pi].Name,
		webPartsSection.Personalization.Providers[pi].Type);
}

// Add an authorization.
AuthorizationRule ar = 
	new AuthorizationRule(AuthorizationRuleAction.Allow);
ar.Verbs.Add("ModifyState");
ar.Users.Add("Admin");
webPartsSection.Personalization.Authorization.Rules.Add(ar);

// List current authorizations. 
for (int ai = 0;
	ai < webPartsSection.Personalization.Authorization.Rules.Count; 
	ai++)
{
	Console.WriteLine("  #{0}:", ai);
	AuthorizationRule aRule = 
		webPartsSection.Personalization.Authorization.Rules[ai];
	Console.WriteLine("  Verbs=");
	foreach (string verb in aRule.Verbs)
		Console.WriteLine("    * {0}", verb);
	Console.WriteLine("  Roles=");
	foreach (string role in aRule.Roles)
		Console.WriteLine("    * {0}", role);
	Console.WriteLine("  Users=");
	foreach (string user in aRule.Users)
		Console.WriteLine("    * {0}", user);
}

.NET Framework

Supported in: 4.5, 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