ConfigurationPropertyAttribute 類別

定義

命名空間:

System.Configuration

組件:

System.Configuration.ConfigurationManager.dll

套件:

System.Configuration.ConfigurationManager v8.0.0

來源:

ConfigurationPropertyAttribute.cs

以宣告方式指示 .NET 將組態屬性具現化。 此類別無法獲得繼承。

C#

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

繼承

Object

Attribute

ConfigurationPropertyAttribute

屬性

AttributeUsageAttribute

範例

下列範例示範如何使用 屬性定義自定義 ConfigurationSection 物件的 ConfigurationPropertyAttribute 屬性。

此範例包含兩個類別。 自訂 UrlsSection 類別會使用 ConfigurationPropertyAttribute 來定義自己的屬性。 類別 UsingConfigurationPropertyAttribute 會使用 來 UrlsSection 讀取和寫入應用程式組態檔中的自定義區段。

C#

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;
        }
    }
}

C#

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();
    }
}

以下是組態檔的摘錄，其中包含上一個範例中所定義的自定義區段。

XML

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

備註

您可以使用 ConfigurationPropertyAttribute 來裝飾組態屬性，這會指示 .NET 使用裝飾參數的值具現化和初始化 屬性。

注意

建立自定義組態專案最簡單的方式是使用屬性化 (宣告式) 模型。 您可以宣告自定義公用屬性，並使用 屬性裝飾它們 ConfigurationPropertyAttribute 。 針對標示此屬性的每個屬性，.NET 會使用反映來讀取裝飾參數，並建立相關的 ConfigurationProperty 實例。 您也可以使用程式設計模型，在此情況下，您必須負責宣告自定義公用屬性並傳回其集合。

.NET 組態系統提供您可以在建立自定義組態項目期間使用的屬性類型。 屬性類型有兩種：

1. 指示 .NET 如何具現化自定義組態專案屬性的類型。 這些類型包括：

   • ConfigurationCollectionAttribute

   • ConfigurationPropertyAttribute

2. 指示 .NET 如何驗證自定義組態專案屬性的類型。 這些類型包括：

   • IntegerValidatorAttribute

   • LongValidatorAttribute

   • RegexStringValidatorAttribute

   • StringValidatorAttribute

   • TimeSpanValidatorAttribute

建構函式

ConfigurationPropertyAttribute(String)

初始化 ConfigurationPropertyAttribute 類別的新執行個體。

屬性

DefaultValue	取得或設定裝飾的屬性之預設值。
IsDefaultCollection	取得或設定值，指出這項是否為裝飾的組態屬性之預設屬性集合。
IsKey	取得或設定值，指出這項是否為裝飾的項目屬性之索引鍵屬性。
IsRequired	取得或設定值，指出是否需要裝飾的項目屬性。
Name	取得裝飾的組態項目屬性的名稱。
Options	取得或設定裝飾的組態項目屬性的 ConfigurationPropertyOptions。
TypeId	在衍生類別中實作時，取得這個 Attribute 的唯一識別碼。 (繼承來源 Attribute)

方法

Equals(Object)	傳回值，這個值指出此執行個體是否與指定的物件相等。 (繼承來源 Attribute)
GetHashCode()	傳回這個執行個體的雜湊碼。 (繼承來源 Attribute)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsDefaultAttribute()	在衍生類別中覆寫時，表示這個執行個體的值是衍生類別的預設值。 (繼承來源 Attribute)
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

適用於

另請參閱

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