ConfigurationSection クラスとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ConfigurationSection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

構成ファイル内のセクションを表します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 ConfigurationSection
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As ConfigurationSection

public abstract class ConfigurationSection
 : ConfigurationElement

C++

public ref class ConfigurationSection abstract
 : public ConfigurationElement

public abstract class ConfigurationSection
 extends ConfigurationElement

JScript

public abstract class ConfigurationSection
 extends ConfigurationElement

解説

ConfigurationSection を使用して、カスタムのセクション型を実装します。ConfigurationSection クラスを拡張して、カスタムハンドリングを提供し、さらにカスタム構成セクションにプログラムからアクセスできるようにします。

セクションは、その処理型を configSections のエントリに登録します。

次の例に示す構成ファイルの抜粋を参照してください。

メモ
以前のバージョンの .NET Framework では、プログラムによって構成設定を変更するために構成セクションハンドラが使用されていました。現在、すべての既定の構成セクションは、ConfigurationSection クラスを拡張するクラスによって表されています。

実装時の注意 プログラムコーディングモデルまたは宣言 (属性付き) コーディングモデルを使用して、カスタム構成セクションを作成できます。

プログラムモデル。このモデルでは、セクション属性ごとにプロパティを作成し、その値の取得と設定の両方、またはそのいずれかを行い、その値を基になる ConfigurationElement 基本クラスの内部プロパティバッグに追加する必要があります。
宣言モデル。属性付きモデルとも呼ばれる、このより単純なモデルを使用すると、セクション属性をプロパティを使用して定義し、属性で装飾できます。これらの属性は、ASP.NET 構成システムに対して、プロパティの型およびその既定値について指示します。リフレクションによって取得したこの情報を使用して、ASP.NET 構成システムはセクションプロパティオブジェクトを作成し、必要な初期化を実行します。

Configuration は、構成ファイルの編集をプログラムから行うことができるようにするクラスです。次に示す方法で、これらのファイルへの読み取りアクセスまたは書き込みアクセスができます。

読み取り。構成情報を読み取るには、GetSection または GetSectionGroup を使用します。読み取りを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルに対する読み取りアクセス許可。
- すべての親構成ファイルに対する読み取りアクセス許可。

アプリケーションが独自の構成に対する読み取り専用アクセスを行う必要がある場合は、GetSection のオーバーロードメソッドを使用することをお勧めします (Web アプリケーションの場合)。クライアントアプリケーションの場合は、GetSection メソッドを使用します。これらのメソッドにより、現在のアプリケーションのキャッシュされた構成値にアクセスできます。こちらの方が、Configuration クラスよりもパフォーマンスが優れています。

メモ
パスパラメータを受け取る静的な GetSection メソッドを使用する場合、パスパラメータは、コードを実行しているアプリケーションを参照している必要があります。そうでない場合は、パラメータが無視され、現在実行中のアプリケーションの構成情報が返されます。

書き込み。構成情報を書き込むには、Save メソッドの 1 つを使用します。書き込みを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルおよびディレクトリに対する書き込みアクセス許可。
- すべての構成ファイルに対する読み取りアクセス許可。

Topic	Location
方法 : ConfigurationSection を使用してカスタム構成セクションを作成する	ASP .NET Web アプリケーションの構成
方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する	ASP .NET Web アプリケーションの構成

使用例

プログラムによってカスタムセクションを実装する方法を次のコード例に示します。

属性モデルを使用して実装されたカスタムセクションを実装および使用する方法を示す完全な例については、ConfigurationElement のトピックを参照してください。

Visual Basic

' Define a custom section.
' The CustomSection type alows to define a custom section 
' programmatically.

NotInheritable Public Class
 CustomSection
   Inherits ConfigurationSection
   ' The collection (property bag) that conatains 
   ' the section properties.
   Private Shared _Properties As
 ConfigurationPropertyCollection
   
   ' Internal flag to disable 
   ' property setting.
   Private Shared _ReadOnly As
 Boolean
   
   ' The FileName property.
    Private Shared _FileName As
 New ConfigurationProperty( _
    "fileName", GetType(String),
 _
    "default.txt", _
    ConfigurationPropertyOptions.IsRequired)
   
   ' The MasUsers property.
    Private Shared _MaxUsers As
 New ConfigurationProperty( _
    "maxUsers", GetType(Long),
 _
    CType(1000, Long), _
    ConfigurationPropertyOptions.None)
   
   ' The MaxIdleTime property.
    Private Shared _MaxIdleTime As
 New ConfigurationProperty( _
    "maxIdleTime", GetType(TimeSpan),
 _
    TimeSpan.FromMinutes(5), _
    ConfigurationPropertyOptions.IsRequired)
   
   
   ' CustomSection constructor.
   Public Sub New()
      ' Property initialization
        _Properties = _
        New ConfigurationPropertyCollection()
      
      _Properties.Add(_FileName)
      _Properties.Add(_MaxUsers)
      _Properties.Add(_MaxIdleTime)
   End Sub 'New
   
   
   ' This is a key customization. 
   ' It returns the initialized property bag.
    Protected Overrides ReadOnly
 Property Properties() _
    As ConfigurationPropertyCollection
        Get
            Return _Properties
        End Get
    End Property
   
   
   
   Private Shadows ReadOnly
 Property IsReadOnly() As Boolean
      Get
         Return _ReadOnly
      End Get
   End Property
   
   
   ' Use this to disable property setting.
   Private Sub ThrowIfReadOnly(propertyName
 As String)
      If IsReadOnly Then
            Throw New ConfigurationErrorsException(
 _
            "The property " + propertyName + "
 is read only.")
      End If
   End Sub 'ThrowIfReadOnly
   
   
   
   ' Customizes the use of CustomSection
    ' by setting _ReadOnly to false.
   ' Remember you must use it along with ThrowIfReadOnly.
   Protected Overrides Function
 GetRuntimeObject() As Object
      ' To enable property setting just assign true to
      ' the following flag.
      _ReadOnly = True
      Return MyBase.GetRuntimeObject()
   End Function 'GetRuntimeObject
   
   
    <StringValidator( _
    InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\",
 _
    MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As
 String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As
 String)
            ' With this you disable the setting.
            ' Renemmber that the _ReadOnly flag must
            ' be set to true in the GetRuntimeObject.
            ThrowIfReadOnly("FileName")
            Me("fileName") = value
        End Set
    End Property
   
   
    <LongValidator( _
    MinValue:=1, MaxValue:=1000000, _
    ExcludeRange:=False)> _
    Public Property MaxUsers() As
 Long
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As
 Long)
            Me("maxUsers") = Value
        End Set
    End Property
   
   
    <TimeSpanValidator( _
    MinValueString:="0:0:30", _
    MaxValueString:="5:00:0", ExcludeRange:=False)>
 _
    Public Property MaxIdleTime() As
 TimeSpan
        Get
            Return CType(Me("maxIdleTime"),
 TimeSpan)
        End Get
        Set(ByVal value As
 TimeSpan)
            Me("maxIdleTime") =
 Value
        End Set
    End Property
End Class 'CustomSection

// Define a custom section.
// The CustomSection type alows to define a custom section 
// programmatically.
public sealed class CustomSection : 
    ConfigurationSection
{
    // The collection (property bag) that conatains 
    // the section properties.
    private static ConfigurationPropertyCollection
 _Properties;
    
    // Internal flag to disable 
    // property setting.
    private static bool
 _ReadOnly;

    // The FileName property.
    private static readonly ConfigurationProperty
 _FileName =
        new ConfigurationProperty("fileName", 
        typeof(string),"default.txt",
 
        ConfigurationPropertyOptions.IsRequired);

    // The MasUsers property.
    private static readonly ConfigurationProperty
 _MaxUsers =
        new ConfigurationProperty("maxUsers", 
        typeof(long), (long)1000, 
        ConfigurationPropertyOptions.None);
    
    // The MaxIdleTime property.
    private static readonly ConfigurationProperty
 _MaxIdleTime =
        new ConfigurationProperty("maxIdleTime", 
        typeof(TimeSpan), TimeSpan.FromMinutes(5), 
        ConfigurationPropertyOptions.IsRequired);

    // CustomSection constructor.
    public CustomSection()
    {
        // Property initialization
        _Properties = 
            new ConfigurationPropertyCollection();

        _Properties.Add(_FileName);
        _Properties.Add(_MaxUsers);
        _Properties.Add(_MaxIdleTime);
   }

  
    // This is a key customization. 
    // It returns the initialized property bag.
    protected override ConfigurationPropertyCollection Properties
    {
        get
        {
            return _Properties;
        }
    }


    private new bool IsReadOnly
    {
        get
        {
            return _ReadOnly;
        }
    }

    // Use this to disable property setting.
    private void ThrowIfReadOnly(string
 propertyName)
    {
        if (IsReadOnly)
            throw new ConfigurationErrorsException(
                "The property " + propertyName + " is read only.");
    }


    // Customizes the use of CustomSection
    // by setting _ReadOnly to false.
    // Remember you must use it along with ThrowIfReadOnly.
    protected override object GetRuntimeObject()
    {
        // To enable property setting just assign true to
        // the following flag.
        _ReadOnly = true;
        return base.GetRuntimeObject();
    }


    [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\"
,
        MinLength = 1, MaxLength = 60)]
    public string FileName
    {
        get
        {
            return (string)this["fileName"];
        }
        set
        {
            // With this you disable the setting.
            // Renemmber that the _ReadOnly flag must
            // be set to true in the GetRuntimeObject.
            ThrowIfReadOnly("FileName");
            this["fileName"] = value;
        }
    }

    [LongValidator(MinValue = 1, MaxValue = 1000000,
        ExcludeRange = false)]
    public long MaxUsers
    {
        get
        {
            return (long)this["maxUsers"];
        }
        set
        {
            this["maxUsers"] = value;
        }
    }

    [TimeSpanValidator(MinValueString = "0:0:30",
        MaxValueString = "5:00:0",
        ExcludeRange = false)]
    public TimeSpan MaxIdleTime
    {
        get
        {
            return  (TimeSpan)this["maxIdleTime"];
        }
        set
        {
            this["maxIdleTime"] = value;
        }
    }
   
    
}

これは、前の例に適用されている構成ファイルの抜粋です。

<?xml version="1.0" encoding="utf-8"?>

<configuration>

<configSections>

<section name="CustomSection" type="Samples.AspNet, CustomConfigurationSection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" allowDefinition="Everywhere" allowExeDefinition="MachineToApplication" restartOnExternalChanges="true" />

</configSections>

<CustomSection fileName="default.txt" maxUsers="1000" maxIdleTime="00:15:00" />

</configuration>

継承階層

System.Object
   System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationSection
       派生クラス

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConfigurationSection メンバ
System.Configuration 名前空間
Configuration クラス
SectionInformation
ConfigurationElement クラス
その他の技術情報
configuration 要素 (全般設定スキーマ)
configSections 要素 (全般設定スキーマ)

このページでは「.NET Framework クラスライブラリリファレンス」からConfigurationSection クラスを検索した結果を表示しています。
Weblioに収録されているすべての辞書からConfigurationSection クラスを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からConfigurationSection クラスを検索

>> 「ConfigurationSection クラス」を含む用語の索引
ConfigurationSection クラスのページへのリンク

ConfigurationSection クラスとは？わかりやすく解説

ConfigurationSection クラス

「ConfigurationSection クラス」の関連用語


	© 2025 Microsoft.All rights reserved.

ConfigurationSection クラスとは？ わかりやすく解説

ConfigurationSection クラス

急上昇のことば

「ConfigurationSection クラス」の関連用語

ConfigurationSection クラスとは？わかりやすく解説