ConfigurationPropertyAttribute Klasse

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paket:

System.Configuration.ConfigurationManager v8.0.0

Quelle:

ConfigurationPropertyAttribute.cs

Weist .NET deklarativ an, eine Konfigurationseigenschaft zu instanziieren. Diese Klasse kann nicht vererbt werden.

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

Vererbung

Object

Attribute

ConfigurationPropertyAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Beispiel zeigt, wie die Eigenschaften eines benutzerdefinierten ConfigurationSection Objekts mithilfe des ConfigurationPropertyAttribute -Attributs definiert werden.

Das Beispiel enthält zwei Klassen. Die UrlsSection benutzerdefinierte Klasse verwendet , ConfigurationPropertyAttribute um eigene Eigenschaften zu definieren. Die UsingConfigurationPropertyAttribute -Klasse verwendet zum UrlsSection Lesen und Schreiben des benutzerdefinierten Abschnitts in der Anwendungskonfigurationsdatei.

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

Im Folgenden ist ein Auszug der Konfigurationsdatei aufgeführt, der den benutzerdefinierten Abschnitt enthält, wie im vorherigen Beispiel definiert.

<?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>  

Hinweise

Sie verwenden die ConfigurationPropertyAttribute , um eine Konfigurationseigenschaft zu ergänzen, die .NET anweist, die Eigenschaft mithilfe des Werts des Decorating-Parameters zu instanziieren und zu initialisieren.

Hinweis

Die einfachste Möglichkeit zum Erstellen eines benutzerdefinierten Konfigurationselements ist die Verwendung des attributierten (deklarativen) Modells. Sie deklarieren die benutzerdefinierten öffentlichen Eigenschaften und versehen sie mit dem ConfigurationPropertyAttribute -Attribut. Für jede Eigenschaft, die mit diesem Attribut gekennzeichnet ist, verwendet .NET Reflektion, um die Dekorationsparameter zu lesen und eine zugehörige ConfigurationProperty instance zu erstellen. Sie können auch das programmgesteuerte Modell verwenden. In diesem Fall liegt es in Ihrer Verantwortung, die benutzerdefinierten öffentlichen Eigenschaften zu deklarieren und deren Sammlung zurückzugeben.

Das .NET-Konfigurationssystem stellt Attributtypen bereit, die Sie während der Erstellung von benutzerdefinierten Konfigurationselementen verwenden können. Es gibt zwei Arten von Attributtypen:

1. Die Typen, die .NET anweisen, wie die benutzerdefinierten Konfigurationselementeigenschaften instanziiert werden. Zu diesen Typen gehören:

   • ConfigurationCollectionAttribute

   • ConfigurationPropertyAttribute

2. Die Typen, die .NET anweisen, wie die benutzerdefinierten Konfigurationselementeigenschaften überprüft werden. Zu diesen Typen gehören:

   • IntegerValidatorAttribute

   • LongValidatorAttribute

   • RegexStringValidatorAttribute

   • StringValidatorAttribute

   • TimeSpanValidatorAttribute

Konstruktoren

ConfigurationPropertyAttribute(String)

Initialisiert eine neue Instanz der ConfigurationPropertyAttribute-Klasse.

Eigenschaften

DefaultValue	Ruft den Standardwert für die ergänzte Eigenschaft ab oder legt diesen fest.
IsDefaultCollection	Ruft einen Wert ab, der angibt, ob dies die Standardeigenschaftenauflistung für die ergänzte Konfigurationseigenschaft ist, oder legt diesen fest.
IsKey	Ruft einen Wert ab, der angibt, ob dies eine Haupteigenschaft für die ergänzte Elementeigenschaft ist, oder legt diesen fest.
IsRequired	Ruft einen Wert ab, der angibt, ob die ergänzte Elementeigenschaft erforderlich ist, oder legt diesen fest.
Name	Ruft den Namen der ergänzten Konfigurationselementeigenschaft ab.
Options	Ruft die ConfigurationPropertyOptions für die ergänzte Eigenschaft des Konfigurationselements ab oder legt diese fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

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