ConfigurationSection 클래스

정의

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

자세히…

예제

다음 예제에서는 사용자 지정 섹션을 프로그래밍 방식으로 구현 하는 방법을 보여 줍니다.The following example shows how to implement a custom section programmatically.

구현 및 사용자 지정 특성 사용된 모델을 사용 하 여 구현 섹션을 사용 하는 방법을 보여 주는 전체 예제를 참조 하세요. ConfigurationElement합니다.For a complete example that shows how to implement and use a custom section implemented using the attributed model, see 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

다음 예제에서는 구성 파일의 일부는 앞의 예제에 적용 됩니다.The following example is an excerpt of the configuration file as it applies to the previous example.

<?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 클래스 사용자 지정 섹션 유형을 구현 하도록 합니다.You use the ConfigurationSection class to implement a custom section type. 확장 된 ConfigurationSection 클래스 사용자 지정 처리 기능 및 사용자 지정 구성 섹션에 대 한 프로그래밍 방식의 액세스를 제공 합니다.Extend the ConfigurationSection class to provide custom handling and programmatic access to custom configuration sections. 사용자 지정 구성 섹션을 사용 하는 방법에 대 한 자세한 내용은 방법: ConfigurationSection을 사용 하 여 사용자 지정 구성 섹션을 만듭니다.For information about how use custom configuration sections, see How to: Create Custom Configuration Sections Using ConfigurationSection.

항목에 해당 처리 유형을 등록 하는 섹션을 configSections 요소입니다.A section registers its handling type with an entry in the configSections element. 예를 들어 예제 단원의 인용한 구성 파일을 참조 하세요.For an example, see the configuration file excerpt shown in the Example section.

구현자 참고

만드는 사용자 지정 구성 섹션을 프로그래밍 방식으로 또는 선언적 코딩 모델 (특성 사용된)를 사용할 수 있습니다.You can use a programmatic or a declarative (attributed) coding model to create custom configuration sections: 프로그래밍 모델입니다.- Programmatic model. 이 모델에서는 각 섹션에서는 특성에 대 한 가져오기 또는 해당 값을 설정 하 고, 기본 내부 propertybag에 추가 속성을 만드는 ConfigurationElement 기본 클래스입니다.This model requires that for each section attribute you create a property to get or set its value and add it to the internal property bag of the underlying ConfigurationElement base class.

선언적 모델입니다.- Declarative model. 특성이 지정 된 모델이 라고도 하는이 간단한 모델을 사용 하면 속성을 사용 하 여 특성으로 데코레이팅 섹션 특성을 정의할 수 있습니다.This simpler model, also called the attributed model, allows you to define a section attribute by using a property and decorating it with attributes. 이러한 특성은 속성 형식과 해당 기본값에 대 한 ASP.NET 구성 시스템을 지시합니다.These attributes instruct the ASP.NET configuration system about the property types and their default values. 리플렉션을 통해 가져온이 정보를 사용 하 여 ASP.NET 구성 시스템 섹션 속성 개체를 만들고 필요한 초기화를 수행 합니다.With this information, obtained through reflection, the ASP.NET configuration system creates the section property objects and performs the required initialization.

Configuration 클래스는 구성 파일 편집에 대 한 프로그래밍 방식의 액세스를 허용 합니다.The Configuration class allows programmatic access for editing configuration files. 이러한 파일을 읽기용 또는 쓰기용 다음과 같이 액세스할 수 있습니다.You can access these files for reading or writing as follows: 읽기입니다.- Reading. 사용할 GetSection(String) 또는 GetSectionGroup(String) 구성 정보를 읽습니다.You use GetSection(String) or GetSectionGroup(String) to read configuration information. Note 사용자나 읽는 프로세스는 다음 권한이 있어야 합니다.Note that the user or process that reads must have the following permissions: -현재 구성 계층 구조 수준에서 구성 파일에서 읽기 권한입니다.- Read permission on the configuration file at the current configuration hierarchy level.

-파일을 읽을 모든 부모에 대 한 권한을 구성 합니다.- Read permissions on all the parent configuration files.

애플리케이션에서 자체 구성에 대 한 읽기 전용 액세스에 필요한 것이 좋습니다 사용 합니다 GetSection 오버 로드 된 웹 애플리케이션의 경우 메서드 또는 GetSection(String) 클라이언트 애플리케이션의 경우 메서드.If your application needs read-only access to its own configuration, it is recommended you use the GetSection overloaded methods in the case of Web applications, or the GetSection(String) method in the case of client applications.

이러한 메서드에 액세스할 수 있는 보다 더 나은 성능을 현재 애플리케이션에 대 한 캐시 된 구성 값에는 Configuration 클래스입니다.These methods provide access to the cached configuration values for the current application, which has better performance than the Configuration class.

정적을 사용 하는 경우 GetSection 사용 하는 메서드를 path 매개 변수는 path 매개 변수는 코드가 실행 되 고이 고, 그렇지 매개 변수는 무시 하는 애플리케이션 및 현재-실행에 대 한 구성 정보를 참조 해야 합니다 애플리케이션에 반환 됩니다.If you use a static GetSection method that takes a path parameter, the path parameter must refer to the application in which the code is running; otherwise, the parameter is ignored and configuration information for the currently-running application is returned.

작성 합니다.- Writing. 하나를 사용 하 여 Save 구성 정보를 기록 하는 방법.You use one of the Save methods to write configuration information. Note는 사용자 또는 기록 하는 프로세스는 다음 권한이 있어야 합니다.Note that the user or process that writes must have the following permissions: -구성 파일 및 디렉터리에서 현재 구성 계층 구조 수준에서 권한을 작성 합니다.- Write permission on the configuration file and directory at the current configuration hierarchy level. -모든 구성 파일에 대 한 권한을 읽습니다.- Read permissions on all the configuration files.

생성자

속성

메서드

적용 대상

추가 정보

• Configuration
• SectionInformation
• ConfigurationElement
• ASP.NET 구성 API 개요ASP.NET Configuration API Overview