Classes utilisées pour créer les gestionnaires de sections personnalisés
Mise à jour : novembre 2007
Si aucune des sections de configuration existantes ne répond à vos besoins, vous pouvez créer des sections personnalisées et implémenter des gestionnaires pour lire et écrire des données de configuration. Le gestionnaire doit être une classe du .NET Framework qui étend la classe ConfigurationSection.
.gif "Remarque") Remarque : |
|---|
Dans les versions 1.0 et 1.1 du .NET Framework, un gestionnaire de section de configuration devait implémenter l'interface IConfigurationSectionHandler, toujours prise en charge dans le .NET Framework version 2.0 mais désapprouvée. |
Les gestionnaires de sections personnalisés peuvent être implémentés à l'aide d'un des deux modèles d'implémentation : le modèle de programmation ou le modèle déclaratif.
Modèle d'implémentation par programmation
Ce modèle exige, pour chaque attribut de section, la création d'une propriété pour obtenir et/ou définir sa valeur et l'ajout de celle-ci à la collection de propriétés interne de la classe de base ConfigurationElement sous-jacente.
Modèle d'implémentation déclarative
Ce modèle, également appelé modèle attribué, vous permet de définir un attribut section en utilisant une propriété et en définissant des attributs. Ces attributs donnent au système de configuration ASP.NET des informations sur les types de propriété et leurs valeurs par défaut. Avec ces informations, obtenues par réflexion, le système de configuration ASP.NET crée les objets propriétés de section et exécute l'initialisation requise. Pour plus d'informations sur la réflexion, consultez Vue d'ensemble de la réflexion.
Classes utilisées pour créer les gestionnaires de sections personnalisés
Le tableau suivant répertorie les classes utilisées pour créer des gestionnaires de sections personnalisés par programme.
Les différentes rubriques sur les classes présentent des exemples de code détaillés qui utilisent l'un ou l'autre ou les deux modèles d'implémentation. En outre, vous pouvez consulter un exemple de code déclaratif simplifié dans Comment : créer des sections de configuration personnalisées à l'aide de ConfigurationSection.
Classes utilisées pour implémenter un gestionnaire de section |
Description |
|---|---|
Classe ConfigurationSection |
Représente une section dans un fichier de configuration. Utilisez la classe ConfigurationSection pour implémenter un type de gestionnaire de section personnalisé. Étendez la classe ConfigurationSection pour fournir une gestion personnalisée et un accès par programme aux sections de configuration personnalisées. Une section enregistre son type de gestion par une entrée dans l'élément configSections d'un fichier de configuration. |
Représente une collection de sections connexes dans un fichier de configuration. Utilisez ConfigurationSectionCollection pour la création de types personnalisés qui étendent la classe ConfigurationSection. Vous pouvez par ailleurs l'utiliser pour lire, par programme, un fichier de configuration dans une collection d'objets ConfigurationSection. |
|
Représente une collection d'éléments dans un fichier de configuration. Utilisez la classe ConfigurationElementCollection pour manipuler une collection d'objets ConfigurationElement. Implémentez cette classe pour ajouter des collections d'éléments ConfigurationElement personnalisés à ConfigurationSection. |
|
Classe ConfigurationElement |
Représente un élément dans un fichier de configuration. Utilisez la classe ConfigurationElement comme classe de base des classes qui représentent des éléments de configuration XML, par exemple ConfigurationSection. Vous pouvez étendre la classe ConfigurationElement pour représenter un élément de configuration dans une classe ConfigurationSection. Vous pouvez également créer une collection ConfigurationElementCollection d'éléments ConfigurationElement. Chaque objet ConfigurationElement crée une collection ConfigurationPropertyCollection interne d'objets ConfigurationProperty qui représentent soit les attributs de l'élément, soit une collection d'éléments enfants. |
Indique, de façon déclarative, au .NET Framework d'instancier une collection de propriétés d'un élément de configuration. Utilisez ConfigurationCollectionAttribute pour ajouter des attributs à une propriété ConfigurationElementCollection. Cela indique au .NET Framework d'instancier la propriété et de l'initialiser à l'aide de vos valeurs ConfigurationElement personnalisées. |
|
La classe ConfigurationPropertyCollection représente la collection des objets ConfigurationProperty qui peuvent être des attributs ou des objets ConfigurationElement d'un élément de configuration. |
|
Classe ConfigurationProperty |
Représente un attribut ou un enfant d'un élément de configuration. Dans le cas d'un élément ConfigurationElement simple, les objets ConfigurationProperty représentent des attributs. Dans le cas d'éléments de configuration plus complexes tels qu'une section contenant des sous-sections, les objets ConfigurationProperty peuvent représenter tant des objets ConfigurationElement que des attributs. La classe ConfigurationProperty représente un paramètre de configuration individuel. Cette classe vous permet d'obtenir ou de définir le nom, le type et la valeur par défaut d'une entité de configuration particulière (attribut ou élément) et de spécifie si l'attribut est obligatoire, s'il représente une clé de collection ou une collection d'éléments par défaut. |
Indique, de façon déclarative, au .NET Framework d'instancier une propriété d'élément de configuration. Utilisez ConfigurationPropertyAttribute pour décorer une propriété d'un élément de configuration. Cela indique au .NET Framework d'instancier et d'initialiser la propriété à l'aide de la valeur du paramètre de décoration. |
Voir aussi
Tâches
Comment : créer des sections de configuration personnalisées à l'aide de ConfigurationSection
Concepts
Structure du fichier de configuration ASP.NET (sections et gestionnaires de sections)