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 示しています。

この例には、2 つのクラスが含まれています。 カスタム クラスでは 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 構成システムには、カスタム構成要素の作成時に使用できる属性型が用意されています。 属性の型には、次の 2 種類があります。

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