Paramètres d'application pour les contrôles personnalisés
Mise à jour : novembre 2007
Vous devez exécuter certaines tâches pour permettre à vos contrôles personnalisés de faire persister les paramètres d'application lorsqu'ils sont hébergés dans des applications tierces.
La plupart de la documentation relative à la fonctionnalité Paramètres de l'application est rédigée en partant du principe que vous créez une application autonome. Toutefois, si vous créez un contrôle que d'autres développeurs hébergeront dans leurs applications, vous devez exécuter quelques étapes supplémentaires afin que les paramètres du contrôle soient correctement rendus persistants.
Paramètres d'application et contrôles personnalisés
Pour que votre contrôle rende correctement ses paramètres persistants, il doit encapsuler le processus en créant sa propre classe wrapper de paramètres d'applications dédiée, dérivée de ApplicationSettingsBase. En outre, la classe de contrôle principale doit implémenter IPersistComponentSettings. L'interface contient plusieurs propriétés, ainsi que deux méthodes (LoadComponentSettings et SaveComponentSettings). Si vous ajoutez votre contrôle à un formulaire à l'aide du Concepteur Windows Forms dans Visual Studio, Windows Forms appelle automatiquement LoadComponentSettings lorsque le contrôle est initialisé ; vous devez quant à vous appeler SaveComponentSettings dans la méthode Dispose de votre contrôle.
De plus, vous devez implémenter les éléments suivants pour que les paramètres d'application des contrôles personnalisés fonctionnent correctement dans les environnements au moment du design, tels que Visual Studio :
Classe de paramètres d'application personnalisés avec un constructeur qui accepte un IComponent comme paramètre unique. Utilisez cette classe pour enregistrer et charger tous vos paramètres d'application. Lorsque vous créez une instance de cette classe, passez votre contrôle personnalisé à l'aide du constructeur.
Créez cette classe de paramètres personnalisés une fois que le contrôle a été créé et placé sur un formulaire, tel que dans le gestionnaire d'événements Load du formulaire.
Pour plus d'informations sur la création d'une classe de paramètres personnalisés, consultez Comment : créer des paramètres d'application.
Clés des paramètres et paramètres partagés
Certains contrôles peuvent être utilisés plusieurs fois dans le même formulaire. La plupart du temps, vous souhaiterez que les propres paramètres des contrôles soient persistants. Lorsque la propriété SettingsKey a la valeur IPersistComponentSettings, vous pouvez fournir une chaîne unique qui lève toute ambiguïté relative aux différentes versions d'un contrôle présent dans un formulaire.
La façon la plus simple d'implémenter SettingsKey consiste à utiliser la propriété Name du contrôle pour SettingsKey. Lorsque vous chargez ou enregistrez les paramètres du contrôle, vous transmettez la valeur de SettingsKey à la propriété SettingsKey de la classe ApplicationSettingsBase. La fonctionnalité Paramètres de l'application utilise cette clé unique lorsqu'elle rend les paramètres de l'utilisateur persistants en XML. L'exemple de code suivant illustre la présentation d'une section <userSettings> pour une instance d'un contrôle personnalisé CustomControl1 qui enregistre un paramètre pour sa propriété Text .
<userSettings>
<CustomControl1>
<setting name="Text" serializedAs="string">
<value>Hello, World</value>
</setting>
</CustomControl1>
</userSettings>
Toutes les instances d'un contrôle ne fournissant pas de valeur pour SettingsKey partageront les mêmes paramètres.
Voir aussi
Concepts
Architecture des paramètres d'application