ClientTargetCollection.Clear 方法

定义

命名空间:

System.Web.Configuration

程序集:

System.Web.dll

从集合中移除所有 ClientTarget 对象。

public:
 void Clear();

public void Clear ();

member this.Clear : unit -> unit

Public Sub Clear ()

示例

下面的代码示例从ClientTargetCollection集合中删除所有 ClientTarget 对象。

有关如何获取集合的信息，请参阅类概述中的 ClientTargetCollection 代码示例。

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

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

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

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

注解

调用 Clear 方法后更新配置文件的结果取决于 ConfigurationSaveMode 所选值。 若要更新配置文件，请使用以下两种方法之一： Configuration.Save 或 Configuration.Save。

备注

调用Configuration.Save等效于修改值时ConfigurationSaveMode调用Save。

如果使用 Configuration.Save 方法，则以下条件适用：

• 如果传递 Full 或 Modified 参数值，则会 clear 在当前层次结构级别将元素插入 clientTarget 配置文件的 节。

• 如果传递 Minimal 参数值，则会在当前层次结构级别将一系列 remove 元素添加到 clientTarget 配置文件的 部分。 这会删除对层次结构中 add 较高级别的父配置文件中定义的元素的所有引用。 Minimal使用 枚举值时，集合上的一个附加属性会影响序列化到配置文件的内容。 属性为 EmitClear ，默认情况下为 false 。 以下条件之一适用：

  • 当 设置为 true时EmitClear，clear元素将插入到clientTarget当前层次结构级别的配置文件的 节中。 这会删除对层次结构中 add 较高级别的父配置文件中定义的元素的所有引用。

  • 当 设置为 false时EmitClear，将从clear当前层次结构级别的配置文件的 节中删除 clientTarget 元素（如果存在）。

方法 Clear 实际上删除在 add 当前层次结构级别的配置文件的 节中 clientTarget 定义的元素。 它还会删除对层次结构中 add 较高级别的父配置文件中定义的元素的所有引用。

备注

add元素不会从clientTarget父配置文件的 节中删除。

另请参阅

• ClientTarget
• ClientTargetSection