ConfigurationProperty ConfigurationProperty ConfigurationProperty ConfigurationProperty Class

Definizione

Rappresenta un attributo o un elemento figlio di un elemento di configurazione.Represents an attribute or a child of a configuration element. Questa classe non può essere ereditata.This class cannot be inherited.

Questa API supporta l'infrastruttura del prodotto e non è previsto che venga usata direttamente dal codice.

public ref class ConfigurationProperty sealed
public sealed class ConfigurationProperty
type ConfigurationProperty = class
Public NotInheritable Class ConfigurationProperty
Ereditarietà
ConfigurationPropertyConfigurationPropertyConfigurationPropertyConfigurationProperty

Esempi

  1. Nell'esempio di codice seguente viene illustrato come utilizzare ConfigurationProperty quando si crea una sezione personalizzata.The following code example shows how to use the ConfigurationProperty when you create a custom section.
using System;
using System.Configuration;
using System.Collections;
using System.ComponentModel;

namespace ConfigurationPropertyExample
{
    // Define a custom section.
    // Shows how to use the ConfigurationProperty
    // class when defining a custom section.
    public sealed class CustomSection : ConfigurationSection
    {
        // The collection (property bag) that contains 
        // the section properties.
        private static ConfigurationPropertyCollection _Properties;

        // The FileName property.
        private static ConfigurationProperty _FileName;

        // The Alias property.
        private static ConfigurationProperty _Alias;

        // The MaxUsers property.
        private static ConfigurationProperty _MaxUsers;

        // The MaxIdleTime property.
        private static ConfigurationProperty _MaxIdleTime;

        // CustomSection constructor.
        static CustomSection()
        {
            // Initialize the _FileName property
            _FileName =
                new ConfigurationProperty("fileName",
                typeof(string), "default.txt");

            // Initialize the _MaxUsers property
            _MaxUsers =
                new ConfigurationProperty("maxUsers",
                typeof(long), (long)1000,
                ConfigurationPropertyOptions.None);

            // Initialize the _MaxIdleTime property
            TimeSpan minTime = TimeSpan.FromSeconds(30);
            TimeSpan maxTime = TimeSpan.FromMinutes(5);

            ConfigurationValidatorBase _TimeSpanValidator =
                new TimeSpanValidator(minTime, maxTime, false);

            _MaxIdleTime =
                new ConfigurationProperty("maxIdleTime",
                typeof(TimeSpan), TimeSpan.FromMinutes(5),
                TypeDescriptor.GetConverter(typeof(TimeSpan)),
                _TimeSpanValidator,
                ConfigurationPropertyOptions.IsRequired,
                "[Description:This is the max idle time.]");

            // Initialize the _Alias property
            _Alias =
                new ConfigurationProperty("alias",
                typeof(string), "alias.txt");

            // Initialize the Property collection.
            _Properties = new ConfigurationPropertyCollection();
            _Properties.Add(_FileName);
            _Properties.Add(_Alias);
            _Properties.Add(_MaxUsers);
            _Properties.Add(_MaxIdleTime);
        }

        // Return the initialized property bag
        // for the configuration element.
        protected override ConfigurationPropertyCollection Properties
        {
            get
            {
                return _Properties;
            }
        }

        // Clear the property.
        public void ClearCollection()
        {
            Properties.Clear();
        }

        // Remove an element from the property collection.
        public void RemoveCollectionElement(string elName)
        {
            Properties.Remove(elName);
        }

        // Get the property collection enumerator.
        public IEnumerator GetCollectionEnumerator()
        {
            return (Properties.GetEnumerator());
        }

        [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
            MinLength = 1, MaxLength = 60)]
        public string FileName
        {
            get
            {
                return (string)this["fileName"];
            }
            set
            {
                this["fileName"] = value;
            }
        }

        [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
            MinLength = 1, MaxLength = 60)]
        public string Alias
        {
            get
            {
                return (string)this["alias"];
            }
            set
            {
                this["alias"] = value;
            }
        }

        [LongValidator(MinValue = 1, MaxValue = 1000000,
            ExcludeRange = false)]
        public long MaxUsers
        {
            get
            {
                return (long)this["maxUsers"];
            }
            set
            {
                this["maxUsers"] = value;
            }
        }

        public TimeSpan MaxIdleTime
        {
            get
            {
                return (TimeSpan)this["maxIdleTime"];
            }
            set
            {
                this["maxIdleTime"] = value;
            }
        }
    }
}
Imports System.Configuration
Imports System.Collections
Imports System.ComponentModel

' Define a custom section.
' Shows how to use the ConfigurationProperty
' class when defining a custom section.
Public NotInheritable Class CustomSection
    Inherits ConfigurationSection

    ' The collection (property bag) that contains 
    ' the section properties.
    Private Shared _Properties As ConfigurationPropertyCollection

    ' The FileName property.
    Private Shared _FileName As ConfigurationProperty

    ' The Alias property.
    Private Shared _Alias As ConfigurationProperty

    ' The MasUsers property.
    Private Shared _MaxUsers As ConfigurationProperty

    ' The MaxIdleTime property.
    Private Shared _MaxIdleTime As ConfigurationProperty

    ' CustomSection constructor.
    Shared Sub New()

        ' Initialize the _FileName property
        _FileName = New ConfigurationProperty( _
            "fileName", GetType(String), "default.txt")

        ' Initialize the _MaxUsers property
        _MaxUsers = New ConfigurationProperty( _
            "maxUsers", GetType(Long), 1000L, _
            ConfigurationPropertyOptions.None)

        ' Initialize the _MaxIdleTime property
        Dim minTime As TimeSpan = TimeSpan.FromSeconds(30)
        Dim maxTime As TimeSpan = TimeSpan.FromMinutes(5)
        Dim _TimeSpanValidator = _
            New TimeSpanValidator(minTime, maxTime, False)

        _MaxIdleTime = New ConfigurationProperty( _
            "maxIdleTime", GetType(TimeSpan), _
            TimeSpan.FromMinutes(5), _
            TypeDescriptor.GetConverter(GetType(TimeSpan)), _
            _TimeSpanValidator, _
            ConfigurationPropertyOptions.IsRequired, _
            "[Description:This is the max idle time.]")

        ' Initialize the _Alias property
        _Alias = New ConfigurationProperty( _
            "alias", GetType(String), "alias.txt")

        ' Property collection initialization.
        ' The collection (property bag) that contains 
        ' the properties is declared as:
        ' ConfigurationPropertyCollection _Properties;
        _Properties = New ConfigurationPropertyCollection()
        _Properties.Add(_FileName)
        _Properties.Add(_Alias)
        _Properties.Add(_MaxUsers)
        _Properties.Add(_MaxIdleTime)

    End Sub

    ' Return the initialized property bag
    ' for the configuration element.
    Protected Overrides ReadOnly Property Properties() _
    As ConfigurationPropertyCollection
        Get
            Return _Properties
        End Get
    End Property

    <StringValidator(InvalidCharacters:= _
    " ~!@#$%^&*()[]{}/;'""|\", MinLength:=1, _
    MaxLength:=60)> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            Me("fileName") = value
        End Set
    End Property

    <StringValidator(InvalidCharacters:= _
    " ~!@#$%^&*()[]{}/;'""|\", MinLength:=1, _
    MaxLength:=60)> _
    Public Property [Alias]() As String
        Get
            Return CStr(Me("alias"))
        End Get
        Set(ByVal value As String)
            Me("alias") = value
        End Set
    End Property

    <LongValidator(MinValue:=1, _
    MaxValue:=1000000, ExcludeRange:=False)> _
    Public Property MaxUsers() As Long
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As Long)
            Me("maxUsers") = value
        End Set
    End Property

    Public Property MaxIdleTime() As TimeSpan
        Get
            Return CType(Me("maxIdleTime"), TimeSpan)
        End Get
        Set(ByVal value As TimeSpan)
            Me("maxIdleTime") = value
        End Set
    End Property
End Class

Di seguito è riportato un estratto del file di configurazione usato dal codice nell'esempio precedente.The following is an excerpt of the configuration file used by the code in the previous example.

<configuration>
  <configSections>
    <section name="CustomSection" type="ConfigurationPropertyExample.CustomSection, ConfigurationPropertyExample" 
      allowDefinition="Everywhere" allowExeDefinition="MachineToApplication" 
      restartOnExternalChanges="true" />
  </configSections>
  <CustomSection fileName="override.txt" alias="alias.txt" 
    maxUsers="1000" maxIdleTime="00:05:00" />
</configuration>

Nell'esempio seguente viene illustrato come creare la sezione precedente nel codice.The following example shows how to create the previous section in code.

// Define a custom section programmatically.
static void CreateSection()
{
    try
    {
        CustomSection customSection;

        // Get the current configuration file.
        System.Configuration.Configuration config =
                ConfigurationManager.OpenExeConfiguration(
                ConfigurationUserLevel.None);

        // Create the section entry  
        // in the <configSections> and the 
        // related target section in <configuration>.
        // Call it "CustomSection2" since the file in this 
        // example already has "CustomSection".
        if (config.Sections["CustomSection"] == null)
        {
            customSection = new CustomSection();
            config.Sections.Add("CustomSection2", customSection);
            customSection.SectionInformation.ForceSave = true;
            config.Save(ConfigurationSaveMode.Full);
        }
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(err.ToString());
    }
}
' Create a custom section.
Shared Sub CreateSection()
    Try
        Dim customSection As CustomSection

        ' Get the current configuration file.
        Dim config As System.Configuration.Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

        ' Create the section entry  
        ' in the <configSections> and the 
        ' related target section in <configuration>.
        ' Since the config file already has "CustomSection",
        ' call this one "CustomSection2".
        If config.Sections("CustomSection") Is Nothing Then
            customSection = New CustomSection()
            config.Sections.Add("CustomSection", customSection)
            customSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Full)
        End If
    Catch err As ConfigurationErrorsException
        Console.WriteLine(err.ToString())
    End Try
End Sub

Commenti

Nel caso ConfigurationElementdi un semplice, come CustomSection illustrato nell'esempio seguente, gli ConfigurationProperty oggetti rappresentano gli attributi, ad esempio fileName.In the case of a simple ConfigurationElement, such as the CustomSection shown in the next example, the ConfigurationProperty objects represent attributes such as fileName.

Nel caso di elementi di configurazione più complessi, come una sezione che contiene sottosezioni, ad esempio authentication ConfigurationProperty , gli oggetti possono rappresentare ConfigurationElement gli oggetti e gli attributi.In the case of more complex configuration elements such as a section containing subsections, for instance authentication, the ConfigurationProperty objects can represent ConfigurationElement objects as well as attributes.

La ConfigurationPropertyCollection classe rappresenta la raccolta ConfigurationProperty di oggetti che possono essere attributi o ConfigurationElement oggetti di un elemento di configurazione.The ConfigurationPropertyCollection class represents the collection of the ConfigurationProperty objects that can be either attributes or ConfigurationElement objects of a configuration element.

La ConfigurationProperty classe rappresenta una singola impostazione di configurazione.The ConfigurationProperty class represents an individual configuration setting. Questa classe consente di ottenere o impostare il nome, il tipo e il valore predefinito per una particolare entità di configurazione (attributo o elemento) e di specificare se l'attributo è obbligatorio, è una chiave dell'elemento o rappresenta una raccolta di elementi predefiniti.This class allows you to get or set the name, type, and default value for a particular configuration entity (attribute or element) and specify whether the attribute is required, is an element key, or represents a default element collection.

Note per gli eredi

Ogni ConfigurationElement oggetto crea una raccolta ConfigurationPropertyCollection interna di ConfigurationProperty oggetti che rappresenta gli attributi dell'elemento o una raccolta di elementi figlio.Every ConfigurationElement object creates an internal ConfigurationPropertyCollection collection of ConfigurationProperty objects that represents either the element attributes or a collection of child elements.

Le informazioni e le funzionalità non personalizzabili sono contenute in ElementInformation un oggetto fornito ElementInformation dalla proprietà.Non-customizable information and functionality is contained by an ElementInformation object provided by the ElementInformation property.

Per creare un elemento di configurazione personalizzato, è possibile usare un modello di codifica a livello di codice o dichiarativo (con attributi).You can use a programmatic or a declarative (attributed) coding model to create a custom configuration element.

-Modello a livello di codice.- Programmatic Model. Per questo modello è necessario creare una proprietà per ogni attributo dell'elemento per ottenere e/o impostarne il valore e aggiungerlo all'elenco proprietà interno della classe ConfigurationElement base sottostante.This model requires that you create a property for each element attribute to get and/or set its value and add it to the internal property bag of the underlying ConfigurationElement base class.

: Modello dichiarativo.- Declarative Model. Questo modello più semplice, detto anche modello con attributi, consente di definire un attributo dell'elemento utilizzando una proprietà e di decorarla con attributi.This simpler model, also called attributed model, allows you to define an element attribute by using a property and decorate it with attributes. Questi attributi indicano al sistema di configurazione ASP.NET i tipi di proprietà e i relativi valori predefiniti.These attributes instruct the ASP.NET configuration system about the property types and their default values. Con queste informazioni, ottenute tramite reflection, il sistema di configurazione ASP.NET crea automaticamente gli oggetti proprietà degli elementi ed esegue l'inizializzazione richiesta.With this information, obtained through reflection, the ASP.NET configuration system creates the element property objects for you and performs the required initialization.

Costruttori

ConfigurationProperty(String, Type) ConfigurationProperty(String, Type) ConfigurationProperty(String, Type) ConfigurationProperty(String, Type)

Inizializza una nuova istanza della classe ConfigurationProperty.Initializes a new instance of the ConfigurationProperty class.

ConfigurationProperty(String, Type, Object) ConfigurationProperty(String, Type, Object) ConfigurationProperty(String, Type, Object) ConfigurationProperty(String, Type, Object)

Inizializza una nuova istanza della classe ConfigurationProperty.Initializes a new instance of the ConfigurationProperty class.

ConfigurationProperty(String, Type, Object, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, ConfigurationPropertyOptions)

Inizializza una nuova istanza della classe ConfigurationProperty.Initializes a new instance of the ConfigurationProperty class.

ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions)

Inizializza una nuova istanza della classe ConfigurationProperty.Initializes a new instance of the ConfigurationProperty class.

ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions, String) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions, String) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions, String) ConfigurationProperty(String, Type, Object, TypeConverter, ConfigurationValidatorBase, ConfigurationPropertyOptions, String)

Inizializza una nuova istanza della classe ConfigurationProperty.Initializes a new instance of the ConfigurationProperty class.

Proprietà

Converter Converter Converter Converter

Ottiene la classe TypeConverter utilizzata per convertire questa classe ConfigurationProperty in una rappresentazione XML per la scrittura nel file di configurazione.Gets the TypeConverter used to convert this ConfigurationProperty into an XML representation for writing to the configuration file.

DefaultValue DefaultValue DefaultValue DefaultValue

Ottiene il valore predefinito per questa proprietà ConfigurationProperty.Gets the default value for this ConfigurationProperty property.

Description Description Description Description

Ottiene la descrizione associata alla classe ConfigurationProperty.Gets the description associated with the ConfigurationProperty.

IsAssemblyStringTransformationRequired IsAssemblyStringTransformationRequired IsAssemblyStringTransformationRequired IsAssemblyStringTransformationRequired

Indica se il nome dell'assembly per la proprietà di configurazione richiede la trasformazione quando viene serializzato per una versione precedente di .NET Framework.NET Framework.Indicates whether the assembly name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework.NET Framework.

IsDefaultCollection IsDefaultCollection IsDefaultCollection IsDefaultCollection

Ottiene un valore che indica se la proprietà è l'insieme predefinito di un elemento.Gets a value that indicates whether the property is the default collection of an element.

IsKey IsKey IsKey IsKey

Ottiene un valore che indica se questa classe ConfigurationProperty è la chiave per l'oggetto ConfigurationElement contenitore.Gets a value indicating whether this ConfigurationProperty is the key for the containing ConfigurationElement object.

IsRequired IsRequired IsRequired IsRequired

Ottiene un valore che indica se questa classe ConfigurationProperty è obbligatoria.Gets a value indicating whether this ConfigurationProperty is required.

IsTypeStringTransformationRequired IsTypeStringTransformationRequired IsTypeStringTransformationRequired IsTypeStringTransformationRequired

Indica se il nome del tipo per la proprietà di configurazione richiede la trasformazione quando viene serializzato per una versione precedente di .NET Framework.NET Framework.Indicates whether the type name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework.NET Framework.

IsVersionCheckRequired IsVersionCheckRequired IsVersionCheckRequired IsVersionCheckRequired

Indica se è necessario eseguire query in fase di serializzazione sulla sezione di configurazione padre della proprietà di configurazione per determinare se la proprietà di configurazione deve essere serializzata in XML.Indicates whether the configuration property's parent configuration section is queried at serialization time to determine whether the configuration property should be serialized into XML.

Name Name Name Name

Ottiene il nome di ConfigurationProperty.Gets the name of this ConfigurationProperty.

Type Type Type Type

Ottiene il tipo di questo oggetto ConfigurationProperty.Gets the type of this ConfigurationProperty object.

Validator Validator Validator Validator

Ottiene la classe ConfigurationValidatorAttribute, utilizzata per convalidare questo oggetto ConfigurationProperty.Gets the ConfigurationValidatorAttribute, which is used to validate this ConfigurationProperty object.

Metodi

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Si applica a

Vedi anche