ConfigurationPropertyCollection.Clear メソッド

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

ConfigurationPropertyCollection.Clear メソッド

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

コレクションからすべての構成プロパティ オブジェクトを削除します。

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

Visual Basic (宣言)

Public Sub Clear

Visual Basic (使用法)

Dim instance As ConfigurationPropertyCollection

instance.Clear

C#

public void Clear ()

C++

public:
void Clear ()

J#

public void Clear ()

JScript

public function Clear ()

使用例

Clear メソッドを使用する方法の例を次に示します。

Visual Basic

' Clear the property.
' It deletes all the attributes of the
' configuration element represented by
' the property.
Public Sub ClearCollection()
   Properties.Clear()
End Sub 'ClearCollection

C#

// Clear the property.
// It deletes all the attributes of the
// configuration element represented by
// the property.
public void ClearCollection()
{
    Properties.Clear();
}

上記のメソッドを呼び出して、構成ファイルに変更を保存する方法の例を次に示します。

Visual Basic

' Clear a collection of elements.
Shared Sub ClearCollection()
   Try
      
      Dim customSection As CustomSection
      
         ' Get the current configuration file.
         Dim config As System.Configuration.Configuration
 = _
         ConfigurationManager.OpenExeConfiguration( _
         ConfigurationUserLevel.None)

         ' Get the custom section.
         customSection = _
         config.GetSection("CustomSection")

         customSection.ClearCollection()

         If Not customSection.IsReadOnly()
 Then
             customSection.SectionInformation.ForceSave = True
             config.Save(ConfigurationSaveMode.Full)
         End If
   
   Catch err As ConfigurationErrorsException
      Console.WriteLine(err.ToString())
   End Try
End Sub 'ClearCollection
 

C#

// Clear a collection of elements.
static void ClearCollection()
{
    try
    {

        CustomSection customSection;

        // Get the current configuration file.
        System.Configuration.Configuration config =
                ConfigurationManager.OpenExeConfiguration(
                ConfigurationUserLevel.None);

        customSection =
            config.GetSection("CustomSection") as CustomSection;
        customSection.ClearCollection();

        if (!customSection.IsReadOnly())
        {
            customSection.SectionInformation.ForceSave = true;
            config.Save(ConfigurationSaveMode.Full);
        }

    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(err.ToString());
    }

}

プラットフォーム

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

参照

関連項目
ConfigurationPropertyCollection クラス
ConfigurationPropertyCollection メンバ
System.Configuration 名前空間
ConfigurationProperty クラス
ConfigurationSection
ElementInformation
ConfigurationElementCollection クラス
ConfigurationElementCollectionType 列挙体
ConfigurationElement クラス
ConfigurationSection