WebPartsSection クラス

定義

名前空間:

System.Web.Configuration

アセンブリ:

System.Web.dll

webParts 構成ファイル セクションにプログラムからアクセスできるようにします。 このクラスは継承できません。

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

継承

Object

ConfigurationElement

ConfigurationSection

WebPartsSection

例

この例では、 セクションのいくつかの属性に対して宣言的に値を webParts 指定する方法を示します。これは、 クラスの WebPartsSection メンバーとしてもアクセスできます。

次の構成ファイルの例は、 セクションに値を宣言的に指定する方法を webParts 示しています。

<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 を示します。

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 パーツの個人用設定プロバイダーを指定したり、個人用設定の承認を設定したり、Web パーツ接続で使用するためにクラスをWebPartTransformer拡張するカスタム クラスを追加したりできます。

コンストラクター

WebPartsSection()

既定の設定を使用して WebPartsSection クラスの新しいインスタンスを初期化します。

プロパティ

CurrentConfiguration	現在の Configuration インスタンスが属している構成階層を表す最上位の ConfigurationElement インスタンスへの参照を取得します。 (継承元 ConfigurationElement)
ElementInformation	ElementInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
ElementProperty	ConfigurationElementProperty オブジェクト自体を表す ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
EnableExport	制御データの XML 記述ファイルへのエクスポートを有効にするかどうかを示す値を取得または設定します。
EvaluationContext	ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
HasContext	CurrentConfiguration プロパティが null であるかどうかを示す値を取得します。 (継承元 ConfigurationElement)
Item[ConfigurationProperty]	この構成要素のプロパティまたは属性を取得または設定します。 (継承元 ConfigurationElement)
Item[String]	この構成要素のプロパティ、属性、または子要素を取得または設定します。 (継承元 ConfigurationElement)
LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockAllElementsExcept	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockAttributes	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockElements	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockItem	要素がロックされているかどうかを示す値を取得または設定します。 (継承元 ConfigurationElement)
Personalization	Web パーツ パーソナル化プロバイダーの指定および Web パーツ パーソナル化承認の設定をできるようにする WebPartsPersonalization オブジェクトを取得します。
Properties	プロパティのコレクションを取得します。 (継承元 ConfigurationElement)
SectionInformation	SectionInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationSection オブジェクトを取得します。 (継承元 ConfigurationSection)
Transformers	TransformerInfo オブジェクトのコレクションを取得します。

メソッド

DeserializeElement(XmlReader, Boolean)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationElement)
DeserializeSection(XmlReader)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationSection)
Equals(Object)	現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (継承元 ConfigurationElement)
GetHashCode()	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (継承元 ConfigurationElement)
GetRuntimeObject()	派生クラスでオーバーライドされると、カスタム オブジェクトを返します。 (継承元 ConfigurationSection)
GetTransformedAssemblyString(String)	指定されたアセンブリ名を変換して返します。 (継承元 ConfigurationElement)
GetTransformedTypeString(String)	指定された型名を変換して返します。 (継承元 ConfigurationElement)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Init()	ConfigurationElement オブジェクトを初期状態に設定します。 (継承元 ConfigurationElement)
InitializeDefault()	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (継承元 ConfigurationElement)
IsModified()	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (継承元 ConfigurationSection)
IsReadOnly()	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (継承元 ConfigurationElement)
ListErrors(IList)	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (継承元 ConfigurationElement)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)	必要なプロパティが見つからないと例外がスローされます。 (継承元 ConfigurationElement)
PostDeserialize()	逆シリアル化後に呼び出されます。 (継承元 ConfigurationElement)
PreSerialize(XmlWriter)	シリアル化前に呼び出されます。 (継承元 ConfigurationElement)
Reset(ConfigurationElement)	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (継承元 ConfigurationElement)
ResetModified()	IsModified() メソッドの値が派生クラスに実装されたときに、false にリセットします。 (継承元 ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	ファイルに書き込む 1 つのセクションとして、ConfigurationSection オブジェクトのアンマージされたビューを含む XML 文字列を作成します。 (継承元 ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	プロパティを指定した値に設定します。 (継承元 ConfigurationElement)
SetReadOnly()	IsReadOnly() オブジェクトおよびすべてのサブ要素に ConfigurationElement プロパティを設定します。 (継承元 ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	指定したターゲット バージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、指定した要素をシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	指定したターゲット バージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、指定したプロパティをシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	指定したターゲット バージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、現在 ConfigurationSection のインスタンスをシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (継承元 ConfigurationElement)

こちらもご覧ください

• WebPartTransformer
• ConfigurationSection
• ASP.NET Web パーツ コントロール
• Web パーツ接続の概要
• Web パーツの個人用設定の概要