UrlMappingCollection.Clear メソッド

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

UrlMappingCollection.Clear メソッド

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

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

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

Visual Basic (宣言)

Public Sub Clear

Visual Basic (使用法)

Dim instance As UrlMappingCollection

instance.Clear

C#

public void Clear ()

C++

public:
void Clear ()

J#

public void Clear ()

JScript

public function Clear ()

解説

Clear メソッドの呼び出し後に構成ファイルを保存する場合、結果は選択された ConfigurationSaveMode によって異なります。

ファイルの保存に Save メソッドを使用する場合に適用される条件を次に説明します。

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

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

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

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

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

使用例

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

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

Visual Basic

' Clear the url mapping collection.
urlMappings.Clear()

' Update the configuration file.
' Define the save modality.
Dim saveMode _
As ConfigurationSaveMode = _
ConfigurationSaveMode.Minimal

urlMappings.EmitClear = _
Convert.ToBoolean(parm2)

If parm1 = "none" Then
    If Not urlMappingSection.IsReadOnly() Then
        configuration.Save()
    End If
    msg = String.Format( _
    "Default modality, EmitClear:      {0}", _
    urlMappings.EmitClear.ToString())
Else
    If parm1 = "full" Then
        saveMode = ConfigurationSaveMode.Full
    ElseIf parm1 = "modified" Then
        saveMode = ConfigurationSaveMode.Modified
    End If
    If Not urlMappingSection.IsReadOnly() Then
        configuration.Save(saveMode)
    End If
    msg = String.Format( _
    "Save modality:      {0}", _
    saveMode.ToString())
End If

C#

// Clear the url mapping collection.
urlMappings.Clear();

// Update the configuration file.

// Define the save modality.
ConfigurationSaveMode saveMode =
  ConfigurationSaveMode.Minimal;

urlMappings.EmitClear =
   Convert.ToBoolean(parm2);

if (parm1 == "none")
{
  if (!urlMappingSection.IsReadOnly())
    configuration.Save();
  msg = String.Format(
  "Default modality, EmitClear:      {0}",
  urlMappings.EmitClear.ToString());
}
else
{
  if (parm1 == "full")
    saveMode = ConfigurationSaveMode.Full;
  else
    if (parm1 == "modified")
      saveMode = ConfigurationSaveMode.Modified;

  if (!urlMappingSection.IsReadOnly())
    configuration.Save(saveMode);

  msg = String.Format(
   "Save modality:      {0}",
   saveMode.ToString());
}

プラットフォーム

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

参照

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