ConfigurationLockCollection

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

ConfigurationLockCollection クラス

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

ロックされている構成オブジェクトのコレクションを格納します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 ConfigurationLockCollection
    Implements ICollection, IEnumerable

Visual Basic (使用法)

Dim instance As ConfigurationLockCollection

C#

public sealed class ConfigurationLockCollection
 : ICollection, IEnumerable

C++

public ref class ConfigurationLockCollection
 sealed : ICollection, IEnumerable

J#

public final class ConfigurationLockCollection
 implements ICollection, IEnumerable

JScript

public final class ConfigurationLockCollection
 implements ICollection, IEnumerable

解説

構成ファイルの構成セクションには、属性と要素の両方が含まれています。ConfigurationLockCollection コレクションは、構成セクションのロックされている属性用に存在し、ConfigurationElement クラスの LockAttributes プロパティを使用してアクセスします。もう 1 つの ConfigurationLockCollection コレクションは、構成セクションのロックされている要素用に存在し、ConfigurationElement クラスの LockElements プロパティを使用してアクセスします。

使用例

ConfigurationLockCollection 型を使用する方法を次のコード例に示します。

Visual Basic

Imports System
Imports System.Configuration
Imports System.Web.Configuration
Imports System.Collections
Imports System.Text

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingConfigurationLockCollection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String
 = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration
 = _
         WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As _
        AnonymousIdentificationSection = _
         CType(config.GetSection("system.web/anonymousIdentification"),
 _
         AnonymousIdentificationSection)

        ' Display title and info.
        Console.WriteLine("Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", _
          config.FilePath)
        Console.WriteLine("Section Path: {0}", _
          configSection.SectionInformation.Name)
        Console.WriteLine()

        ' Create a ConfigurationLockCollection object.
        Dim lockedAttribList As ConfigurationLockCollection
        lockedAttribList = configSection.LockAttributes

        ' Add an attribute to the lock collection.
        If Not (lockedAttribList.Contains("enabled"))
 Then
          lockedAttribList.Add("enabled")
        End If
        If Not (lockedAttribList.Contains("cookieless"))
 Then
          lockedAttribList.Add("cookieless")
        End If

        ' Count property.
        Console.WriteLine("Collection Count: {0}",
 _
         lockedAttribList.Count)

        ' AttributeList method.
        Console.WriteLine("AttributeList: {0}", _
         lockedAttribList.AttributeList)

        ' Contains method.
        Console.WriteLine("Contains 'enabled': {0}", _
         lockedAttribList.Contains("enabled"))

        ' HasParentElements property.
        Console.WriteLine("HasParentElements: {0}",
 _
         lockedAttribList.HasParentElements)

        ' IsModified property.
        Console.WriteLine("IsModified: {0}", _
         lockedAttribList.IsModified)

        ' IsReadOnly method. 
        Console.WriteLine("IsReadOnly: {0}", _
         lockedAttribList.IsReadOnly("enabled"))

        ' Remove a configuration object 
        ' from the collection.
        lockedAttribList.Remove("cookieless")

        ' Clear the collection.
        lockedAttribList.Clear()

        ' Create an ArrayList to contain
        ' the property items of the configuration
        ' section.
        Dim configPropertyAL As ArrayList =
 _
         New ArrayList(lockedAttribList.Count)
        For Each propertyItem As
 _
         PropertyInformation In _
         configSection.ElementInformation.Properties
          configPropertyAL.Add(propertyItem.Name.ToString())
        Next
        ' Copy the elements of the ArrayList to a string array.
        Dim myArr As [String]() = _
        CType(configPropertyAL.ToArray(GetType(String)),
 [String]())
        ' Create as a comma delimited list.
        Dim propList As String
 = String.Join(",", myArr)
        ' Lock the items in the list.
        lockedAttribList.SetFromList(propList)

      Catch e As Exception
        ' Validation failed.
        Console.WriteLine("Error: {0}", _
          e.Message.ToString())
      End Try

      ' Display and wait.
      Console.ReadLine()
    End Sub
  End Class
End Namespace

C#

#region Using directives

using System;
using System.Configuration;
using System.Web.Configuration;
using System.Collections;
using System.Text;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingConfigurationLockCollection
  {
    static void Main(string[]
 args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config =
          WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        AnonymousIdentificationSection configSection =
          (AnonymousIdentificationSection)config.GetSection
          ("system.web/anonymousIdentification");

        // Display title and info.
        Console.WriteLine("Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);
        Console.WriteLine();

        // Create a ConfigurationLockCollection object.
        ConfigurationLockCollection lockedAttribList;
        lockedAttribList = configSection.LockAttributes;

        // Add an attribute to the lock collection.
        if (!lockedAttribList.Contains("enabled"))
        {
          lockedAttribList.Add("enabled");
        }
        if (!lockedAttribList.Contains("cookieless"))
        {
          lockedAttribList.Add("cookieless");
        }

        // Count property.
        Console.WriteLine("Collection Count: {0}",
         lockedAttribList.Count);

        // AttributeList method.
        Console.WriteLine("AttributeList: {0}",
         lockedAttribList.AttributeList);

        // Contains method.
        Console.WriteLine("Contains 'enabled': {0}",
         lockedAttribList.Contains("enabled"));

        // HasParentElements property.
        Console.WriteLine("HasParentElements: {0}",
         lockedAttribList.HasParentElements);

        // IsModified property.
        Console.WriteLine("IsModified: {0}",
         lockedAttribList.IsModified);

        // IsReadOnly method. 
        Console.WriteLine("IsReadOnly: {0}",
         lockedAttribList.IsReadOnly("enabled"));

        // Remove a configuration object 
        // from the collection.
        lockedAttribList.Remove("cookieless");

        // Clear the collection.
        lockedAttribList.Clear();

        // Create an ArrayList to contain
        // the property items of the configuration
        // section.
        ArrayList configPropertyAL = new ArrayList(lockedAttribList.Count);
        foreach (PropertyInformation propertyItem in
          configSection.ElementInformation.Properties)
        {
          configPropertyAL.Add(propertyItem.Name.ToString());
        }
        // Copy the elements of the ArrayList to a string array.
        String[] myArr = (String[])configPropertyAL.ToArray(typeof(string));
        // Create as a comma delimited list.
        string propList = string.Join(",",
 myArr);
        // Lock the items in the list.
        lockedAttribList.SetFromList(propList);
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait.
      Console.ReadLine();
    }
  }
}

継承階層

System.Object
  System.Configuration.ConfigurationLockCollection

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConfigurationLockCollection メンバ
System.Configuration 名前空間
ConfigurationElement.LockAllAttributesExcept プロパティ
ConfigurationElement.LockAllElementsExcept プロパティ
ConfigurationElement クラス

ConfigurationLockCollection プロパティ

パブリック プロパティ

	名前	説明
	AttributeList	コレクションに格納されている構成オブジェクトのリストを取得します。
	Count	コレクションに格納されている、ロックされている構成オブジェクトの数を取得します。
	HasParentElements	ロックされているオブジェクトのコレクションに親要素があるかどうかを示す値を取得します。
	IsModified	コレクションが変更されたかどうかを示す値を取得します。
	IsSynchronized	コレクションの同期がとられているかどうかを示す値を取得します。
	SyncRoot	この ConfigurationLockCollection コレクションへのアクセスを同期するために使用するオブジェクトを取得します。

参照

関連項目

ConfigurationLockCollection クラス
System.Configuration 名前空間
ConfigurationElement.LockAllAttributesExcept プロパティ
ConfigurationElement.LockAllElementsExcept プロパティ
ConfigurationElement クラス

ConfigurationLockCollection メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	構成オブジェクトを、コレクションに追加することによってロックします。
	Clear	コレクションからすべての構成オブジェクトを消去します。
	Contains	特定の構成オブジェクトがロックされているかどうかを検査します。
	CopyTo	ConfigurationLockCollection コレクション全体を互換性のある 1 次元の Array にコピーします。コピー操作は、コピー先の配列の指定したインデックスから始まります。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	この ConfigurationLockCollection コレクションを反復処理するために使用される IEnumerator オブジェクトを取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	特定の構成オブジェクトが読み取り専用かどうかを検査します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Remove	構成オブジェクトをコレクションから削除します。
	SetFromList	指定されたリストに基づいて、構成オブジェクトのセットをロックします。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Collections.ICollection.CopyTo	ConfigurationLockCollection コレクション全体を互換性のある 1 次元の Array にコピーします。コピー操作は、コピー先の配列の指定したインデックスから始まります。

参照

関連項目

ConfigurationLockCollection クラス
System.Configuration 名前空間
ConfigurationElement.LockAllAttributesExcept プロパティ
ConfigurationElement.LockAllElementsExcept プロパティ
ConfigurationElement クラス

ConfigurationLockCollection メンバ

ロックされている構成オブジェクトのコレクションを格納します。このクラスは継承できません。

ConfigurationLockCollection データ型で公開されるメンバを以下の表に示します。

パブリック プロパティ

	名前	説明
	AttributeList	コレクションに格納されている構成オブジェクトのリストを取得します。
	Count	コレクションに格納されている、ロックされている構成オブジェクトの数を取得します。
	HasParentElements	ロックされているオブジェクトのコレクションに親要素があるかどうかを示す値を取得します。
	IsModified	コレクションが変更されたかどうかを示す値を取得します。
	IsSynchronized	コレクションの同期がとられているかどうかを示す値を取得します。
	SyncRoot	この ConfigurationLockCollection コレクションへのアクセスを同期するために使用するオブジェクトを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	構成オブジェクトを、コレクションに追加することによってロックします。
	Clear	コレクションからすべての構成オブジェクトを消去します。
	Contains	特定の構成オブジェクトがロックされているかどうかを検査します。
	CopyTo	ConfigurationLockCollection コレクション全体を互換性のある 1 次元の Array にコピーします。コピー操作は、コピー先の配列の指定したインデックスから始まります。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	この ConfigurationLockCollection コレクションを反復処理するために使用される IEnumerator オブジェクトを取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	特定の構成オブジェクトが読み取り専用かどうかを検査します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Remove	構成オブジェクトをコレクションから削除します。
	SetFromList	指定されたリストに基づいて、構成オブジェクトのセットをロックします。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Collections.ICollection.CopyTo	ConfigurationLockCollection コレクション全体を互換性のある 1 次元の Array にコピーします。コピー操作は、コピー先の配列の指定したインデックスから始まります。

参照

関連項目

ConfigurationLockCollection クラス
System.Configuration 名前空間
ConfigurationElement.LockAllAttributesExcept プロパティ
ConfigurationElement.LockAllElementsExcept プロパティ
ConfigurationElement クラス