WebPartsSection WebPartsSection WebPartsSection WebPartsSection Class

定义

提供对 webParts 配置文件节的编程访问。Provides programmatic access to the webParts configuration file section. 此类不能被继承。This class cannot be inherited.

public ref class WebPartsSection sealed : System::Configuration::ConfigurationSection
public sealed class WebPartsSection : System.Configuration.ConfigurationSection
type WebPartsSection = class
    inherit ConfigurationSection
Public NotInheritable Class WebPartsSection
Inherits ConfigurationSection
继承

示例

此示例演示如何以声明方式为webParts部分的多个属性指定值, 该部分也可以作为WebPartsSection类的成员进行访问。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.

下面的配置文件示例演示如何以声明方式为webParts节指定值。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>  

下面的代码示例演示如何使用WebPartsSection类。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.

Imports System.Collections
Imports System.Collections.Specialized
Imports System.IO
Imports System.Text
Imports System.Text.RegularExpressions
Imports System.Configuration
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  ' Accesses the System.Web.Configuration.WebPartsSection
  ' members selected by the user.
  Class UsingWebPartsSection
    Public Shared Sub Main()
      ' Process the System.Web.Configuration.WebPartsSectionobject.
      Try
        ' Get the Web application configuration.
                Dim configuration As System.Configuration.Configuration = _
        WebConfigurationManager.OpenWebConfiguration("/aspnet")

        ' Get the section.
        Dim webPartsSection As WebPartsSection = _
         CType(configuration.Sections("system.web/webParts"), _
         WebPartsSection)

' 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.
Dim ti As Integer
For ti = 0 To webPartsSection.Personalization.Providers.Count - 1
  Console.WriteLine("  #{0} Name={1} Type={2}", ti, _
    webPartsSection.Transformers(ti).Name, _
    webPartsSection.Transformers(ti).Type)
Next

' 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.
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

                ' Update if not locked.
                If Not webPartsSection.IsReadOnly() Then
                    configuration.Save()
                    Console.WriteLine("** Configuration updated.")
                Else
                    Console.WriteLine("** Could not update, section is locked.")
                End If
            Catch e As System.ArgumentException
        ' Unknown error.
        Console.WriteLine( _
          "A invalid argument exception detected in UsingWebPartsSection Main. Check your")
        Console.WriteLine("command line for errors.")
      End Try
    End Sub
  End Class
End Namespace ' Samples.Aspnet.SystemWebConfiguration

注解

" webParts配置文件" 部分可用于指定 Web 部件个性化设置提供程序、设置个性化设置授权以及添加自定义类, WebPartTransformer这些类用于扩展类以供 Web 部件连接使用。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.

构造函数

WebPartsSection() WebPartsSection() WebPartsSection() WebPartsSection()

使用默认设置初始化 WebPartsSection 类的新实例。Initializes a new instance of the WebPartsSection class using default settings.

属性

CurrentConfiguration CurrentConfiguration CurrentConfiguration CurrentConfiguration

获取对顶级 Configuration 实例的引用,该实例表示当前 ConfigurationElement 实例所属的配置层次结构。Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Inherited from ConfigurationElement)
ElementInformation ElementInformation ElementInformation ElementInformation

获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Inherited from ConfigurationElement)
ElementProperty ElementProperty ElementProperty ElementProperty

获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EnableExport EnableExport EnableExport EnableExport

获取或设置一个值,该值指示是否允许将控件数据导出为 XML 说明文件。Gets or sets a value indicating whether to enable the export of control data to an XML description file.

EvaluationContext EvaluationContext EvaluationContext EvaluationContext

获取 ConfigurationElement 对象的 ContextInformation 对象。Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext HasContext HasContext HasContext

获取一个值,该值指示 CurrentConfiguration 属性是否为 nullGets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty]

获取或设置此配置元素的属性或特性。Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String] Item[String] Item[String] Item[String]

获取或设置此配置元素的属性、特性或子元素。Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept

获取被锁定的特性的集合。Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept

获取被锁定的元素的集合。Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes LockAttributes LockAttributes LockAttributes

获取被锁定的特性的集合。Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockElements LockElements LockElements LockElements

获取被锁定的元素的集合。Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem LockItem LockItem LockItem

获取或设置一个值,该值指示是否已锁定该元素。Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
Personalization Personalization Personalization Personalization

获取一个 WebPartsPersonalization 对象,该对象允许指定 Web 部件个性化设置提供器,并设置 Web 部件个性化授权。Gets a WebPartsPersonalization object that allows you to specify the Web Parts personalization provider and set Web Parts personalization authorizations.

Properties Properties Properties Properties

获取属性的集合。Gets the collection of properties.

(Inherited from ConfigurationElement)
SectionInformation SectionInformation SectionInformation SectionInformation

获取一个 SectionInformation 对象,该对象包含 ConfigurationSection 对象的不可自定义的信息和功能。Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object.

(Inherited from ConfigurationSection)
Transformers Transformers Transformers Transformers

获取 TransformerInfo 对象的集合。Gets a collection of TransformerInfo objects.

方法

DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean)

从配置文件读取 XML。Reads XML from the configuration file.

(Inherited from ConfigurationElement)
DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader)

从配置文件读取 XML。Reads XML from the configuration file.

(Inherited from ConfigurationSection)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

将当前的 ConfigurationElement 实例与指定的对象进行比较。Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

获取表示当前 ConfigurationElement 实例的唯一值。Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetRuntimeObject() GetRuntimeObject() GetRuntimeObject() GetRuntimeObject()

在派生的类中重写时返回自定义对象。Returns a custom object when overridden in a derived class.

(Inherited from ConfigurationSection)
GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String)

返回指定程序集名称的转换版本。Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String)

返回指定类型名称的转换版本。Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType() GetType() GetType() GetType()

获取当前实例的 TypeGets the Type of the current instance.

(Inherited from Object)
Init() Init() Init() Init()

ConfigurationElement 对象设置为其初始状态。Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault() InitializeDefault() InitializeDefault() InitializeDefault()

用于初始化 ConfigurationElement 对象的默认值集。Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
IsModified() IsModified() IsModified() IsModified()

指示自上次在派生类中实现此配置元素时保存或加载以来是否对其进行过修改。Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.

(Inherited from ConfigurationSection)
IsReadOnly() IsReadOnly() IsReadOnly() IsReadOnly()

获取一个值,该值指示 ConfigurationElement 对象是否为只读。Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList) ListErrors(IList) ListErrors(IList) ListErrors(IList)

将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String)

获取一个值,该值指示反序列化过程中是否遇到未知特性。Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader)

获取一个值,该值指示反序列化过程中是否遇到未知元素。Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String)

找不到所需属性时引发异常。Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize() PostDeserialize() PostDeserialize() PostDeserialize()

反序列化后调用。Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter)

在序列化之前调用。Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement)

重置 ConfigurationElement 对象的内部状态,包括锁和属性集合。Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Inherited from ConfigurationElement)
ResetModified() ResetModified() ResetModified() ResetModified()

在派生类中实现时,将 IsModified() 方法的值重置为 falseResets the value of the IsModified() method to false when implemented in a derived class.

(Inherited from ConfigurationSection)
SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean)

当在派生类中实现后,将此配置元素的内容写入配置文件。Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

创建一个包含 ConfigurationSection 对象的分离视图的 XML 字符串,作为单独的节写入到文件中。Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.

(Inherited from ConfigurationSection)
SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String)

当在派生类中实现后,将此配置元素的外部标记写入配置文件。Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean)

将属性设置为指定值。Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly() SetReadOnly() SetReadOnly() SetReadOnly()

设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

指示在为 .NET Framework.NET Framework 的指定目标版本序列化配置对象层次结构时,是否应序列化指定元素。Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Inherited from ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

指示在为指定目标版本的 .NET Framework.NET Framework 序列化配置对象层次结构时,是否应序列化指定属性。Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Inherited from ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName)

指示在为指定目标版本的 .NET Framework.NET Framework 序列化配置对象层次结构时,是否应序列化当前的 ConfigurationSection 实例。Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Inherited from ConfigurationSection)
ToString() ToString() ToString() ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

修改 ConfigurationElement 对象以移除所有不应该保存的值。Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

适用于

另请参阅