CustomErrorCollection.Clear Метод

Определение

Пространство имен:

System.Web.Configuration

Сборка:

System.Web.dll

Удаляет все объекты CustomError из коллекции.

public:
 void Clear();

public void Clear ();

member this.Clear : unit -> unit

Public Sub Clear ()

Примеры

В следующем примере кода удаляются CustomError все объекты из CustomErrorCollection коллекции. Сведения о том, как получить коллекцию, см. в примере кода в CustomErrorCollection разделе класса.

// Using the Clear method.
if (!customErrorsSection.SectionInformation.IsLocked)
{
    // Execute the Clear method.
    customErrorsCollection.Clear();
    configuration.Save();
}

' Using the Clear method.
If Not customErrorsSection.SectionInformation.IsLocked Then
   ' Execute the Clear method.
   customErrorsCollection.Clear()
   configuration.Save()
End If

Комментарии

Результат обновления файла конфигурации после вызова Clear метода зависит от выбранного ConfigurationSaveMode . Чтобы обновить файл конфигурации, используйте одну из двух перегрузок: Save и Save.

Примечание

Вызов Save эквивалентен вызову Save.

При использовании Saveметода .method применяются следующие условия.

• При передаче Full значения параметра или Modified элемент вставляется в clientTarget раздел файла конфигурации на текущем clear уровне иерархии.

• При передаче Minimal значения параметра в элемент clientTarget (ASP.NET Settings Schema) файла конфигурации на текущем уровне иерархии добавляется ряд remove элементов. Каждая из них удаляет все ссылки на элемент, определенный add в родительском файле конфигурации на более высоком уровне иерархии. При использовании Minimalв коллекции есть одно дополнительное свойство, которое влияет на то, что сериализуется в файл конфигурации: EmitClear, которое по умолчанию имеет значение false . В данном случае действуют следующие условия.

  • EmitClear Если для задано значение true, clear элемент вставляется в clientTarget раздел файла конфигурации на текущем уровне иерархии. При этом удаляются все ссылки на элементы, add определенные в родительских файлах конфигурации на более высоких уровнях иерархии.

  • Если для флага EmitClear задано значение false, clear элемент удаляется из clientTarget раздела файла конфигурации на текущем уровне иерархии, если он существует.

Метод Clear фактически удаляет элементы, add определенные в clientTarget разделе файла конфигурации на текущем уровне иерархии. Он также удаляет все ссылки на элементы добавления, определенные в родительских файлах конфигурации на более высоких уровнях иерархии.

Примечание

Элементы add не удаляются из clientTarget раздела родительских файлов конфигурации.