Export (0) Print
Expand All

WebPartsSection Class

Provides programmatic access to the webParts configuration file section. This class cannot be inherited.

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

public sealed class WebPartsSection : ConfigurationSection
public final class WebPartsSection extends ConfigurationSection
public final class WebPartsSection extends ConfigurationSection
Not applicable.

The webParts configuration file section allows you to specify a Web Parts personalization provider, set personalization authorizations, and add custom classes that extend the WebPartTransformer class for use by Web Parts connections.

This example demonstrates how to specify values declaratively for several attributes of the webParts section, which can also be accessed as members of the WebPartsSection 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="Admin" verbs="modifyState" />
      </authorization>
    </personalization>
    <transformers>
      <add name="RowToFieldTransformer"
        type="System.Web.UI.WebControls.WebParts.RowToFieldTransformer" />
      <add name="RowToFilterTransformer"
        type="System.Web.UI.WebControls.WebParts.RowToFilterTransformer" />
      <add name="RowToParametersTransformer"
type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" />
    </transformers>
  </webParts>
</system.web>

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

using System;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;
using System.Configuration;
using System.Configuration.Provider;
using System.Web.Configuration;

namespace Samples.Aspnet.SystemWebConfiguration
{
	// Accesses the System.Web.Configuration.WebPartsSection
	// members selected by the user.
	class UsingWebPartsSection
	{
		public static void Main()
		{
			// Process the System.Web.Configuration.WebPartsSectionobject.
			try
			{
				// Get the Web application configuration.
				Configuration configuration = 
					WebConfigurationManager.OpenWebConfiguration("/aspnet");

				// Get the section.
				WebPartsSection webPartsSection = (WebPartsSection) 
					configuration.Sections["system.web/webParts"];
// Add a Transfomer Info Object to the collection using a constructor.
webPartsSection.Transformers.Add(new TransformerInfo(
	"RowToFilterTransformer",
	"MyCustomTransformers.RowToFilterTransformer"));

// Show all TransformerInfo objects in the collection.
for (int ti = 0;
	ti < webPartsSection.Personalization.Providers.Count; ti++)
{
	Console.WriteLine("  #{0} Name={1} Type={2}", ti,
		webPartsSection.Transformers[ti].Name,
		webPartsSection.Transformers[ti].Type);
}

// Remove a TransformerInfo object by name.
webPartsSection.Transformers.Remove("RowToFilterTransformer");

// Remove a TransformerInfo object by index.
webPartsSection.Transformers.RemoveAt(0);

// Clear all TransformerInfo objects from the collection.
webPartsSection.Transformers.Clear();

// 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);
}


				// Update if not locked.
				if (! webPartsSection.IsReadOnly())
				{
					configuration.Save();
					Console.WriteLine("** Configuration updated.");
				}
				else
					Console.WriteLine("** Could not update, section is locked.");
			}
			catch (System.ArgumentException e)
			{
				// Unknown error.
				Console.WriteLine(
					"A invalid argument exception detected in UsingWebPartsSection Main. Check your");
				Console.WriteLine("command line for errors.");
			}
		}
	} // UsingWebPartsSection class end.

} // Samples.Aspnet.SystemWebConfiguration namespace end.


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 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft