ClientTargetCollection.Clear メソッド

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

ClientTargetCollection.Clear メソッド

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

コレクションからすべての ClientTarget オブジェクトを削除します。

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

Visual Basic (宣言)

Public Sub Clear

Visual Basic (使用法)

Dim instance As ClientTargetCollection

instance.Clear

C#

public void Clear ()

C++

public:
void Clear ()

J#

public void Clear ()

JScript

public function Clear ()

解説

Clear メソッドが呼び出された後の構成ファイルの更新結果は、選択された ConfigurationSaveMode 値によって異なります。構成ファイルを更新するには、Configuration.Save か Configuration.Save のいずれかのメソッドを使用します。

メモ
Configuration.Save の呼び出しは、Save の呼び出しと等価です。

Save メソッドを使用する場合、次の条件が適用されます。

• Full または Modified のパラメータ値を渡した場合、clear 要素が現在の階層レベルの構成ファイルの clientTarget セクションに挿入されます。

• Minimal パラメータ値を渡した場合、一連の remove 要素が現在の階層レベルの構成ファイルの clientTarget に追加されます。これにより、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照が削除されます。Minimal 列挙値を使用することで構成ファイルにシリアル化されるアイテムに影響を与えるプロパティが、もう 1 つコレクションに存在します。それは EmitClear プロパティで、既定では false です。次のいずれかの条件が適用されます。

  • EmitClear が true に設定されています。clear 要素が、現在の階層レベルの構成ファイルの clientTarget セクションに挿入されます。これにより、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照が削除されます。

  • EmitClear フラグが false に設定されています。これにより、現在の階層レベルの構成ファイルの clientTarget セクションに clear 要素が存在する場合は、それが削除されます。

Clear メソッドは、現在の階層レベルの構成ファイルの clientTarget セクションに定義されている add 要素を実際に削除します。このメソッドは、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照も削除します。

メモ
親構成ファイルの clientTarget セクションにある add 要素は削除されません。

使用例

ClientTargetCollection からすべての ClientTarget オブジェクトを削除するコード例を次に示します。

コレクションを取得する方法については、ClientTargetCollection クラスのトピックにあるコード例を参照してください。

Visual Basic

' Clear the client target collection.
clientTargets.Clear()

' Update the configuration file.
If Not clientTargetSection.IsReadOnly() Then
    configuration.Save()
End If

C#

 
// Clear the client target collection.
clientTargets.Clear();

// Update the configuration file.
if (!clientTargetSection.IsReadOnly())
  configuration.Save();

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

関連項目
ClientTargetCollection クラス
ClientTargetCollection メンバ
System.Web.Configuration 名前空間
ClientTarget クラス
ClientTargetSection
その他の技術情報
clientTarget 要素 (ASP.NET 設定スキーマ)