ConfigurationSection Класс

Ссылка

Определение

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

Сборка:: System.Configuration.ConfigurationManager.dll

Сборка:: System.Configuration.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Представляет раздел в файле конфигурации.

public ref class ConfigurationSection abstract : System::Configuration::ConfigurationElement

public abstract class ConfigurationSection : System.Configuration.ConfigurationElement

type ConfigurationSection = class
    inherit ConfigurationElement

Public MustInherit Class ConfigurationSection
Inherits ConfigurationElement

Наследование: Object

ConfigurationElement
ConfigurationSection

Производный: System.Configuration.AppSettingsSection

System.Configuration.ClientSettingsSection

System.Configuration.ConfigurationBuildersSection

System.Configuration.ConnectionStringsSection

System.Configuration.DefaultSection

Подробнее…

Примеры

В следующем примере показано, как программно реализовать пользовательский раздел.

Полный пример реализации и использования пользовательского раздела, реализованного с помощью модели с атрибутами, см. в разделе ConfigurationElement.

// Define a custom section.
// The CustomSection type allows to define a custom section 
// programmatically.
public sealed class CustomSection : 
    ConfigurationSection
{
    // The collection (property bag) that contains 
    // the section properties.
    private static ConfigurationPropertyCollection _Properties;
    
    // Internal flag to disable 
    // property setting.
    private static bool _ReadOnly;

    // The FileName property.
    private static readonly ConfigurationProperty _FileName =
        new ConfigurationProperty("fileName", 
        typeof(string),"default.txt", 
        ConfigurationPropertyOptions.IsRequired);

    // The MaxUsers property.
    private static readonly ConfigurationProperty _MaxUsers =
        new ConfigurationProperty("maxUsers", 
        typeof(long), (long)1000, 
        ConfigurationPropertyOptions.None);
    
    // The MaxIdleTime property.
    private static readonly ConfigurationProperty _MaxIdleTime =
        new ConfigurationProperty("maxIdleTime", 
        typeof(TimeSpan), TimeSpan.FromMinutes(5), 
        ConfigurationPropertyOptions.IsRequired);

    // CustomSection constructor.
    public CustomSection()
    {
        // Property initialization
        _Properties = 
            new ConfigurationPropertyCollection();

        _Properties.Add(_FileName);
        _Properties.Add(_MaxUsers);
        _Properties.Add(_MaxIdleTime);
   }

    // This is a key customization. 
    // It returns the initialized property bag.
    protected override ConfigurationPropertyCollection Properties
    {
        get
        {
            return _Properties;
        }
    }

    private new bool IsReadOnly
    {
        get
        {
            return _ReadOnly;
        }
    }

    // Use this to disable property setting.
    private void ThrowIfReadOnly(string propertyName)
    {
        if (IsReadOnly)
            throw new ConfigurationErrorsException(
                "The property " + propertyName + " is read only.");
    }

    // Customizes the use of CustomSection
    // by setting _ReadOnly to false.
    // Remember you must use it along with ThrowIfReadOnly.
    protected override object GetRuntimeObject()
    {
        // To enable property setting just assign true to
        // the following flag.
        _ReadOnly = true;
        return base.GetRuntimeObject();
    }


    [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
        MinLength = 1, MaxLength = 60)]
    public string FileName
    {
        get
        {
            return (string)this["fileName"];
        }
        set
        {
            // With this you disable the setting.
            // Remember that the _ReadOnly flag must
            // be set to true in the GetRuntimeObject.
            ThrowIfReadOnly("FileName");
            this["fileName"] = value;
        }
    }

    [LongValidator(MinValue = 1, MaxValue = 1000000,
        ExcludeRange = false)]
    public long MaxUsers
    {
        get
        {
            return (long)this["maxUsers"];
        }
        set
        {
            this["maxUsers"] = value;
        }
    }

    [TimeSpanValidator(MinValueString = "0:0:30",
        MaxValueString = "5:00:0",
        ExcludeRange = false)]
    public TimeSpan MaxIdleTime
    {
        get
        {
            return  (TimeSpan)this["maxIdleTime"];
        }
        set
        {
            this["maxIdleTime"] = value;
        }
    }
}

' Define a custom section.
' The CustomSection type allows to define a custom section 
' programmatically.

NotInheritable Public Class CustomSection
   Inherits ConfigurationSection
   ' The collection (property bag) that contains 
   ' the section properties.
   Private Shared _Properties As ConfigurationPropertyCollection
   
   ' Internal flag to disable 
   ' property setting.
   Private Shared _ReadOnly As Boolean
   
   ' The FileName property.
    Private Shared _FileName As New ConfigurationProperty( _
    "fileName", GetType(String), _
    "default.txt", _
    ConfigurationPropertyOptions.IsRequired)
   
   ' The MaxUsers property.
    Private Shared _MaxUsers As New ConfigurationProperty( _
    "maxUsers", GetType(Long), _
    CType(1000, Long), _
    ConfigurationPropertyOptions.None)
   
   ' The MaxIdleTime property.
    Private Shared _MaxIdleTime As New ConfigurationProperty( _
    "maxIdleTime", GetType(TimeSpan), _
    TimeSpan.FromMinutes(5), _
    ConfigurationPropertyOptions.IsRequired)
   
   
   ' CustomSection constructor.
   Public Sub New()
      ' Property initialization
        _Properties = _
        New ConfigurationPropertyCollection()
      
      _Properties.Add(_FileName)
      _Properties.Add(_MaxUsers)
      _Properties.Add(_MaxIdleTime)
   End Sub
   
   
   ' This is a key customization. 
   ' It returns the initialized property bag.
    Protected Overrides ReadOnly Property Properties() _
    As ConfigurationPropertyCollection
        Get
            Return _Properties
        End Get
    End Property
   
   
   
   Private Shadows ReadOnly Property IsReadOnly() As Boolean
      Get
         Return _ReadOnly
      End Get
   End Property
   
   
   ' Use this to disable property setting.
   Private Sub ThrowIfReadOnly(propertyName As String)
      If IsReadOnly Then
            Throw New ConfigurationErrorsException( _
            "The property " + propertyName + " is read only.")
      End If
   End Sub
   
   
   
   ' Customizes the use of CustomSection
    ' by setting _ReadOnly to false.
   ' Remember you must use it along with ThrowIfReadOnly.
   Protected Overrides Function GetRuntimeObject() As Object
      ' To enable property setting just assign true to
      ' the following flag.
      _ReadOnly = True
      Return MyBase.GetRuntimeObject()
   End Function 'GetRuntimeObject
   
   
    <StringValidator( _
    InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\", _
    MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            ' With this you disable the setting.
            ' Remember that the _ReadOnly flag must
            ' be set to true in the GetRuntimeObject.
            ThrowIfReadOnly("FileName")
            Me("fileName") = value
        End Set
    End Property
   
   
    <LongValidator( _
    MinValue:=1, MaxValue:=1000000, _
    ExcludeRange:=False)> _
    Public Property MaxUsers() As Long
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As Long)
            Me("maxUsers") = Value
        End Set
    End Property
   
   
    <TimeSpanValidator( _
    MinValueString:="0:0:30", _
    MaxValueString:="5:00:0", ExcludeRange:=False)> _
    Public Property MaxIdleTime() As TimeSpan
        Get
            Return CType(Me("maxIdleTime"), TimeSpan)
        End Get
        Set(ByVal value As TimeSpan)
            Me("maxIdleTime") = Value
        End Set
    End Property
End Class

В следующем примере показан фрагмент файла конфигурации, который применяется к предыдущему примеру.

<?xml version="1.0" encoding="utf-8"?>
 <configuration>  
   <configSections>
     <section name="CustomSection" type="Samples.AspNet. CustomSection, CustomConfigurationSection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" allowDefinition="Everywhere" allowExeDefinition="MachineToApplication" restartOnExternalChanges="true" />
   </configSections>  

   <CustomSection fileName="default.txt" maxUsers="1000" maxIdleTime="00:15:00" /> 

 </configuration>

Класс используется для ConfigurationSection реализации пользовательского типа раздела. Расширьте класс для предоставления пользовательской ConfigurationSection обработки и программного доступа к разделам пользовательской конфигурации. Сведения об использовании разделов настраиваемой конфигурации см. в разделе "Практическое руководство. Создание разделов пользовательской конфигурации с помощью ConfigurationSection".

Раздел регистрирует тип обработки с записью в элементе configSections . Пример см. в фрагменте файла конфигурации, показанном в разделе "Пример".

Примечание

В предыдущих версиях платформа .NET Framework обработчики разделов конфигурации использовались для программного внесения изменений в параметры конфигурации. Теперь все разделы конфигурации по умолчанию представлены классами, расширяющими ConfigurationSection класс.

Примечания для тех, кто реализует этот метод

Для создания пользовательских разделов конфигурации можно использовать программную или декларативную (приписываемую) модель кодирования: — Программная модель. Эта модель требует, чтобы для каждого атрибута раздела вы создали свойство, чтобы получить или задать его значение, и добавить его во внутренний контейнер свойств базового ConfigurationElement класса.

— декларативная модель. Эта простая модель, также называемая моделью с атрибутами, позволяет определить атрибут раздела с помощью свойства и декорировать его атрибутами. Эти атрибуты указывают системе конфигурации ASP.NET о типах свойств и их значениях по умолчанию. Используя эти сведения, полученные с помощью отражения, система конфигурации ASP.NET создает объекты свойств раздела и выполняет необходимую инициализацию.

Класс Configuration разрешает программный доступ для редактирования файлов конфигурации. Вы можете получить доступ к этим файлам для чтения или записи следующим образом: — чтение. Используется GetSection(String) или GetSectionGroup(String) для чтения сведений о конфигурации. Обратите внимание, что пользователь или процесс чтения должны иметь следующие разрешения: — разрешение на чтение файла конфигурации на текущем уровне иерархии конфигурации.

— чтение разрешений для всех родительских файлов конфигурации.

Если приложению требуется доступ только для чтения к собственной конфигурации, рекомендуется использовать GetSection перегруженные методы в случае веб-приложений или GetSection(String) метод в случае клиентских приложений.

Эти методы предоставляют доступ к кэшируемым значениям конфигурации для текущего приложения, что обеспечивает лучшую производительность, чем Configuration класс.

Примечание. Если используется статический GetSection метод, принимающий path параметр, параметр должен ссылаться на приложение, path в котором выполняется код; в противном случае параметр игнорируется и возвращается информация о конфигурации текущего приложения.

Написание. Для записи сведений Save о конфигурации используется один из методов. Обратите внимание, что у пользователя или процесса, записываемого в систему, должны быть следующие разрешения: — разрешение на запись файла конфигурации и каталога на текущем уровне иерархии конфигурации.

— разрешение на чтение всех файлов конфигурации.

Конструкторы

ConfigurationSection()

Инициализирует новый экземпляр класса ConfigurationSection.

Свойства

CurrentConfiguration	Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement)
ElementInformation	Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
ElementProperty	Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement. (Унаследовано от ConfigurationElement)
EvaluationContext	Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
HasContext	Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение `null`. (Унаследовано от ConfigurationElement)
Item[ConfigurationProperty]	Возвращает или задает свойство или атрибут данного элемента конфигурации. (Унаследовано от ConfigurationElement)
Item[String]	Получает или задает свойство, атрибут или дочерний элемент данного элемента конфигурации. (Унаследовано от ConfigurationElement)
LockAllAttributesExcept	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockAllElementsExcept	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockAttributes	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockElements	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockItem	Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement)
Properties	Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement)
SectionInformation	Возвращает объект SectionInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationSection.

Методы

DeserializeElement(XmlReader, Boolean)	Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement)
DeserializeSection(XmlReader)	Считывает XML из файла конфигурации.
Equals(Object)	Сравнивает текущий экземпляр ConfigurationElement с указанным объектом. (Унаследовано от ConfigurationElement)
GetHashCode()	Получает уникальное значение, представляющее текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement)
GetRuntimeObject()	Возвращает пользовательский объект при переопределении в производном классе.
GetTransformedAssemblyString(String)	Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement)
GetTransformedTypeString(String)	Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
Init()	Задает объект ConfigurationElement в исходное состояние. (Унаследовано от ConfigurationElement)
InitializeDefault()	Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
IsModified()	При реализации в производном классе указывает, был ли изменен данный элемент конфигурации с момента последнего сохранения или загрузки.
IsReadOnly()	Получает значение, показывающее, является ли объект ConfigurationElement доступным только для чтения. (Унаследовано от ConfigurationElement)
ListErrors(IList)	Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку. (Унаследовано от ConfigurationElement)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
OnDeserializeUnrecognizedAttribute(String, String)	Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации. (Унаследовано от ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Возвращает значение, указывающее, встретился ли неизвестный элемент при десериализации. (Унаследовано от ConfigurationElement)
OnRequiredPropertyNotFound(String)	Выдает исключение, если требуемое свойство не найдено. (Унаследовано от ConfigurationElement)
PostDeserialize()	Вызывается после десериализации. (Унаследовано от ConfigurationElement)
PreSerialize(XmlWriter)	Вызывается до сериализации. (Унаследовано от ConfigurationElement)
Reset(ConfigurationElement)	Восстанавливает внутреннее состояние объекта ConfigurationElement, включая блокировки и коллекции свойств. (Унаследовано от ConfigurationElement)
ResetModified()	Переустанавливает значение метода IsModified() в `false` при реализации в производном классе.
SerializeElement(XmlWriter, Boolean)	Записывает содержание данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Создает XML-строку, содержащую разъединенное представление об объекте ConfigurationSection, как об отдельном разделе, записываемым в файл.
SerializeToXmlElement(XmlWriter, String)	Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Задает для свойства указанное значение. (Унаследовано от ConfigurationElement)
SetReadOnly()	Задает свойство IsReadOnly() для объекта ConfigurationElement и всех подчиненных элементов. (Унаследовано от ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Указывает, следует ли сериализовать указанный элемент при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework.
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Указывает, следует ли сериализовать указанное свойство при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework.
ShouldSerializeSectionInTargetVersion(FrameworkName)	Указывает, следует ли сериализовать текущий ConfigurationSection экземпляр при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Изменяет объект ConfigurationElement для удаления всех значений, которые не должны сохраняться. (Унаследовано от ConfigurationElement)

Применяется к