ConfigurationPropertyAttribute Kelas

Definisi

Ruang nama:

System.Configuration

Rakitan:

System.Configuration.ConfigurationManager.dll

Paket:

System.Configuration.ConfigurationManager v8.0.0

Sumber:

ConfigurationPropertyAttribute.cs

Secara deklaratif menginstruksikan .NET untuk membuat instans properti konfigurasi. Kelas ini tidak dapat diwariskan.

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

Warisan

Object

Attribute

ConfigurationPropertyAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut menunjukkan cara menentukan properti objek kustom ConfigurationSection menggunakan ConfigurationPropertyAttribute atribut .

Contohnya berisi dua kelas. Kelas UrlsSection kustom menggunakan ConfigurationPropertyAttribute untuk menentukan propertinya sendiri. Kelas UsingConfigurationPropertyAttribute menggunakan UrlsSection untuk membaca dan menulis bagian kustom dalam file konfigurasi aplikasi.

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

Berikut ini adalah kutipan file konfigurasi yang berisi bagian kustom seperti yang didefinisikan dalam sampel sebelumnya.

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

Keterangan

Anda menggunakan ConfigurationPropertyAttribute untuk menghias properti konfigurasi, yang akan menginstruksikan .NET untuk membuat instans dan menginisialisasi properti menggunakan nilai parameter dekorasi.

Catatan

Cara paling sederhana untuk membuat elemen konfigurasi kustom adalah dengan menggunakan model atribut (deklaratif). Anda mendeklarasikan properti publik kustom dan mendekorasinya dengan ConfigurationPropertyAttribute atribut . Untuk setiap properti yang ditandai dengan atribut ini, .NET menggunakan pantulan untuk membaca parameter dekorasi dan membuat instans terkait ConfigurationProperty . Anda juga dapat menggunakan model terprogram, dalam hal ini Anda bertanggung jawab untuk mendeklarasikan properti publik kustom dan mengembalikan koleksinya.

Sistem konfigurasi .NET menyediakan jenis atribut yang dapat Anda gunakan selama pembuatan elemen konfigurasi kustom. Ada dua jenis jenis atribut:

1. Jenis yang menginstruksikan .NET cara membuat instans properti elemen konfigurasi kustom. Jenis-jenisnya meliputi:

   • ConfigurationCollectionAttribute

   • ConfigurationPropertyAttribute

2. Jenis yang menginstruksikan .NET cara memvalidasi properti elemen konfigurasi kustom. Jenis-jenisnya meliputi:

   • IntegerValidatorAttribute

   • LongValidatorAttribute

   • RegexStringValidatorAttribute

   • StringValidatorAttribute

   • TimeSpanValidatorAttribute

Konstruktor

ConfigurationPropertyAttribute(String)

Menginisialisasi instans ConfigurationPropertyAttribute kelas baru.

Properti

DefaultValue	Mendapatkan atau mengatur nilai default untuk properti yang didekorasi.
IsDefaultCollection	Mendapatkan atau menetapkan nilai yang menunjukkan apakah ini adalah kumpulan properti default untuk properti konfigurasi yang dihiasi.
IsKey	Mendapatkan atau menetapkan nilai yang menunjukkan apakah ini adalah properti kunci untuk properti elemen yang dihiasi.
IsRequired	Mendapatkan atau menetapkan nilai yang menunjukkan apakah properti elemen yang didekorasi diperlukan.
Name	Mendapatkan nama properti elemen konfigurasi yang dihiasi.
Options	Mendapatkan atau mengatur ConfigurationPropertyOptions untuk properti elemen konfigurasi yang dihiasi.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)

Metode

Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa di kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

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