ConfigurationPropertyAttribute Sınıf

Tanım

Ad Alanı:

System.Configuration

Bütünleştirilmiş Kod:

System.Configuration.ConfigurationManager.dll

Paket:

System.Configuration.ConfigurationManager v8.0.0

Kaynak:

ConfigurationPropertyAttribute.cs

Bildirimli olarak .NET'e yapılandırma özelliğinin örneğini oluşturmasını bildirir. Bu sınıf devralınamaz.

public ref class ConfigurationPropertyAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class ConfigurationPropertyAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type ConfigurationPropertyAttribute = class
    inherit Attribute

Public NotInheritable Class ConfigurationPropertyAttribute
Inherits Attribute

Devralma

Object

Attribute

ConfigurationPropertyAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnekte, özniteliğini kullanarak özel ConfigurationSection bir nesnenin özelliklerinin nasıl tanımlanacağı gösterilmektedir ConfigurationPropertyAttribute .

Örnekte iki sınıf vardır. Özel UrlsSection sınıf kendi özelliklerini tanımlamak için kullanır ConfigurationPropertyAttribute . sınıfı, UsingConfigurationPropertyAttribute uygulama yapılandırma dosyasındaki özel bölümü okumak ve yazmak için öğesini kullanır UrlsSection .

using System;
using System.Configuration;

// Define a custom section.
// This class shows how to use the ConfigurationPropertyAttribute.
public class UrlsSection : ConfigurationSection
{
    [ConfigurationProperty("name", DefaultValue = "Contoso",
        IsRequired = true, IsKey = true)]
    public string Name
    {
        get
        {
            return (string)this["name"];
        }
        set
        {
            this["name"] = value;
        }
    }

    [ConfigurationProperty("url", DefaultValue = "http://www.contoso.com",
        IsRequired = true)]
    [RegexStringValidator(@"\w+:\/\/[\w.]+\S*")]
    public string Url
    {
        get
        {
            return (string)this["url"];
        }
        set
        {
            this["url"] = value;
        }
    }

    [ConfigurationProperty("port", DefaultValue = (int)0, IsRequired = false)]
    [IntegerValidator(MinValue = 0, MaxValue = 8080, ExcludeRange = false)]
    public int Port
    {
        get
        {
            return (int)this["port"];
        }
        set
        {
            this["port"] = value;
        }
    }
}

Imports System.Configuration


' Define a custom section.
' This class shows how to use the ConfigurationPropertyAttribute.
Public Class UrlsSection
    Inherits ConfigurationSection
    <ConfigurationProperty("name", DefaultValue:="Contoso", IsRequired:=True, IsKey:=True)>
    Public Property Name() As String
        Get
            Return CStr(Me("name"))
        End Get
        Set(ByVal value As String)
            Me("name") = value
        End Set
    End Property

    <ConfigurationProperty("url", DefaultValue:="http://www.contoso.com", IsRequired:=True), RegexStringValidator("\w+:\/\/[\w.]+\S*")>
    Public Property Url() As String
        Get
            Return CStr(Me("url"))
        End Get
        Set(ByVal value As String)
            Me("url") = value
        End Set
    End Property

    <ConfigurationProperty("port", DefaultValue:=0, IsRequired:=False), IntegerValidator(MinValue:=0, MaxValue:=8080, ExcludeRange:=False)>
    Public Property Port() As Integer
        Get
            Return CInt(Fix(Me("port")))
        End Get
        Set(ByVal value As Integer)
            Me("port") = value
        End Set
    End Property
End Class

using System;
using System.Configuration;

public class UsingConfigurationPropertyAttribute
{

    // Create a custom section and save it in the 
    // application configuration file.
    static void CreateCustomSection()
    {
        try
        {

            // Create a custom configuration section.
            UrlsSection customSection = new UrlsSection();

            // Get the current configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

            // Add the custom section to the application
            // configuration file.
            if (config.Sections["CustomSection"] == null)
            {
                config.Sections.Add("CustomSection", customSection);
            }

            // Save the application configuration file.
            customSection.SectionInformation.ForceSave = true;
            config.Save(ConfigurationSaveMode.Modified);

            Console.WriteLine("Created custom section in the application configuration file: {0}",
                config.FilePath);
            Console.WriteLine();
        }
        catch (ConfigurationErrorsException err)
        {
            Console.WriteLine("CreateCustomSection: {0}", err.ToString());
        }
    }

    static void ReadCustomSection()
    {
        try
        {
            // Get the application configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None) as Configuration;

            // Read and display the custom section.
            UrlsSection customSection =
                config.GetSection("CustomSection") as UrlsSection;
            Console.WriteLine("Reading custom section from the configuration file.");
            Console.WriteLine("Section name: {0}", customSection.Name);
            Console.WriteLine("Url: {0}", customSection.Url);
            Console.WriteLine("Port: {0}", customSection.Port);
            Console.WriteLine();
        }
        catch (ConfigurationErrorsException err)
        {
            Console.WriteLine("ReadCustomSection(string): {0}", err.ToString());
        }
    }
    
    static void Main(string[] args)
    {
       
        // Get the name of the application.
        string appName =
            Environment.GetCommandLineArgs()[0];

        // Create a custom section and save it in the 
        // application configuration file.
        CreateCustomSection();

        // Read the custom section saved in the
        // application configuration file.
        ReadCustomSection();

        Console.WriteLine("Press enter to exit.");

        Console.ReadLine();
    }
}

Imports System.Configuration

Public Class UsingConfigurationPropertyAttribute

    ' Create a custom section and save it in the 
    ' application configuration file.
    Private Shared Sub CreateCustomSection()
        Try

            ' Create a custom configuration section.
            Dim customSection As New UrlsSection()

            ' Get the current configuration file.
            Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)

            ' Add the custom section to the application
            ' configuration file.
            If config.Sections("CustomSection") Is Nothing Then
                config.Sections.Add("CustomSection", customSection)
            End If


            ' Save the application configuration file.
            customSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Modified)

            Console.WriteLine("Created custom section in the application configuration file: {0}", config.FilePath)
            Console.WriteLine()

        Catch err As ConfigurationErrorsException
            Console.WriteLine("CreateCustomSection: {0}", err.ToString())
        End Try

    End Sub

    Private Shared Sub ReadCustomSection()
        Try
            ' Get the application configuration file.
            Dim config As System.Configuration.Configuration = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)

            ' Read and display the custom section.
            Dim customSection As UrlsSection = TryCast(config.GetSection("CustomSection"), UrlsSection)
            Console.WriteLine("Reading custom section from the configuration file.")
            Console.WriteLine("Section name: {0}", customSection.Name)
            Console.WriteLine("Url: {0}", customSection.Url)
            Console.WriteLine("Port: {0}", customSection.Port)
            Console.WriteLine()
        Catch err As ConfigurationErrorsException
            Console.WriteLine("ReadCustomSection(string): {0}", err.ToString())
        End Try

    End Sub

    Shared Sub Main(ByVal args() As String)

        ' Get the name of the application.
        Dim appName As String = Environment.GetCommandLineArgs()(0)

        ' Create a custom section and save it in the 
        ' application configuration file.
        CreateCustomSection()

        ' Read the custom section saved in the
        ' application configuration file.
        ReadCustomSection()

        Console.WriteLine("Press enter to exit.")

        Console.ReadLine()
    End Sub
End Class

Aşağıda, önceki örnekte tanımlandığı gibi özel bölümü içeren yapılandırma dosyasının bir alıntısı verilmiştir.

<?xml version="1.0" encoding="utf-8"?>  
<configuration>  
    <configSections>  
        <section name="CustomSection" type="UrlsSection, UsingConfigurationPropertyAttribute, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />  
    </configSections>  
    <CustomSection name="Contoso" url="http://www.contoso.com" />  
</configuration>  

Açıklamalar

bir yapılandırma özelliğini süslemek için öğesini kullanırsınız ConfigurationPropertyAttribute . Bu, .NET'e özelliğin örneğini oluşturmasını ve dekorasyon parametresinin değerini kullanarak özelliği başlatmasını belirtir.

Not

Özel yapılandırma öğesi oluşturmanın en basit yolu, öznitelikli (bildirim temelli) modeli kullanmaktır. Özel ortak özellikleri bildirir ve öznitelikle ConfigurationPropertyAttribute süslersiniz. Bu öznitelikle işaretlenmiş her özellik için .NET, dekorasyon parametrelerini okumak ve ilgili ConfigurationProperty bir örnek oluşturmak için yansıma kullanır. Programlı modeli de kullanabilirsiniz; bu durumda özel genel özellikleri bildirmek ve koleksiyonlarını döndürmek sizin sorumluluğunuzdadır.

.NET yapılandırma sistemi, özel yapılandırma öğelerinin oluşturulması sırasında kullanabileceğiniz öznitelik türleri sağlar. İki tür öznitelik türü vardır:

1. .NET'e özel yapılandırma öğesi özelliklerinin örneğini nasıl oluşturacaklarını öğreten türler. Bu türler şunları içerir:

   • ConfigurationCollectionAttribute

   • ConfigurationPropertyAttribute

2. .NET'e özel yapılandırma öğesi özelliklerini nasıl doğrulayacaklarını belirten türler. Bu türler şunları içerir:

   • IntegerValidatorAttribute

   • LongValidatorAttribute

   • RegexStringValidatorAttribute

   • StringValidatorAttribute

   • TimeSpanValidatorAttribute

Oluşturucular

ConfigurationPropertyAttribute(String)

Yeni bir ConfigurationPropertyAttribute sınıfı örneğini başlatır.

Özellikler

DefaultValue	Süslü özellik için varsayılan değeri alır veya ayarlar.
IsDefaultCollection	Bunun süslü yapılandırma özelliği için varsayılan özellik koleksiyonu olup olmadığını belirten bir değer alır veya ayarlar.
IsKey	Bunun, süslü öğe özelliği için bir anahtar özelliği olup olmadığını belirten bir değer alır veya ayarlar.
IsRequired	Süslü öğe özelliğinin gerekli olup olmadığını belirten bir değer alır veya ayarlar.
Name	Süslü configuration-element özelliğinin adını alır.
Options	Süslü configuration-element özelliği için öğesini ConfigurationPropertyOptions alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür. (Devralındığı yer: Attribute)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• ConfigurationProperty
• ConfigurationCollectionAttribute
• IntegerValidatorAttribute
• LongValidatorAttribute
• RegexStringValidatorAttribute
• StringValidatorAttribute
• TimeSpanValidatorAttribute