ConfigurationPropertyAttribute Třída

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.ConfigurationManager.dll

Balíček:

System.Configuration.ConfigurationManager v11.0.0-preview.5.26302.115

Zdroj:

ConfigurationPropertyAttribute.cs

Deklarativní dává rozhraní .NET pokyn k vytvoření instance vlastnosti konfigurace. Tato třída se nemůže dědit.

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

Dědičnost

Object

Attribute

ConfigurationPropertyAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje, jak definovat vlastnosti vlastního ConfigurationSection objektu pomocí atributu ConfigurationPropertyAttribute .

Příklad obsahuje dvě třídy. Vlastní UrlsSection třída používá ConfigurationPropertyAttribute k definování svých vlastních vlastností. Třída UsingConfigurationPropertyAttribute používá UrlsSection ke čtení a zápisu vlastního oddílu v konfiguračním souboru aplikace.

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

Následuje výňatek konfiguračního souboru obsahujícího vlastní oddíl definovaný v předchozí ukázce.

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

Poznámky

Použijete ConfigurationPropertyAttribute k dekoraci konfigurační vlastnosti, která .NET inicializovat instanci a inicializovat vlastnost pomocí hodnoty dekorační parametru.

Note

Nejjednodušší způsob, jak vytvořit vlastní element konfigurace, je použít atributovaný (deklarativní) model. Deklarujete vlastní veřejné vlastnosti a ozdobíte je atributem ConfigurationPropertyAttribute . Pro každou vlastnost označenou tímto atributem .NET používá reflexi ke čtení parametrů dekorace a vytvoření související instance ConfigurationProperty. Programový model můžete použít také v takovém případě, že je vaší zodpovědností deklarovat vlastní veřejné vlastnosti a vrátit jejich kolekci.

Konfigurační systém .NET poskytuje typy atributů, které můžete použít při vytváření vlastních elementů konfigurace. Existují dva typy atributů:

1. Typy instrukující .NET vytvoření instance vlastních vlastností elementu konfigurace. Mezi tyto typy patří:

   • ConfigurationCollectionAttribute

   • ConfigurationPropertyAttribute

2. Typy instrukující .NET, jak ověřit vlastnosti vlastního elementu konfigurace. Mezi tyto typy patří:

   • IntegerValidatorAttribute

   • LongValidatorAttribute

   • RegexStringValidatorAttribute

   • StringValidatorAttribute

   • TimeSpanValidatorAttribute

Konstruktory

Name	Description
ConfigurationPropertyAttribute(String)	Inicializuje novou instanci ConfigurationPropertyAttribute třídy.

Vlastnosti

Name	Description
DefaultValue	Získá nebo nastaví výchozí hodnotu pro dekorované vlastnosti.
IsDefaultCollection	Získá nebo nastaví hodnotu určující, zda se jedná o výchozí kolekci vlastností pro zdobenou konfigurační vlastnost.
IsKey	Získá nebo nastaví hodnotu určující, zda se jedná o klíčovou vlastnost pro dekorovaný prvek vlastnost.
IsRequired	Získá nebo nastaví hodnotu určující, zda dekorovaný prvek vlastnost je požadována.
Name	Získá název dekorované vlastnosti configuration-element.
Options	Získá nebo nastaví ConfigurationPropertyOptions pro dekorované configuration-element vlastnost.

Viz také

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