WebPartsPersonalization Class
Allows you to specify the personalization provider and set personalization authorizations. This class cannot be inherited.
System.Configuration.ConfigurationElement
System.Web.Configuration.WebPartsPersonalization
Namespace: System.Web.Configuration
Assembly: System.Web (in System.Web.dll)
The WebPartsPersonalization type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | WebPartsPersonalization | Infrastructure. Initializes a new instance of the WebPartsPersonalization class using default settings. |
| Name | Description | |
|---|---|---|
![]() | Authorization | Gets an AuthorizationSection object containing the Web Parts personalization authorizations for the current Web application. |
![]() | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.) |
![]() | DefaultProvider | Gets or sets the name of the default Web Parts personalization provider. |
![]() | ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item[String] | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
![]() | LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement.) |
![]() | LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
![]() | LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.) |
![]() | Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
![]() | Providers | Gets a ProviderSettingsCollection collection that contains the Web Parts personalization providers for the current Web application. |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.) |
![]() | GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.) |
![]() | InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | IsReadOnly | Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.) |
![]() | Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.) |
![]() | ResetModified | Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
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); }
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.
