IPersistComponentSettings.SettingsKey Propriété

Définition

Espace de noms:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paquet:

System.Configuration.ConfigurationManager v8.0.0

Source:

IPersistComponentSettings.cs

Obtient ou définit la valeur de la clé de paramètres d'application pour l'instance actuelle du contrôle.

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };

public string SettingsKey { get; set; }

member this.SettingsKey : string with get, set

Public Property SettingsKey As String

Valeur de propriété

String

String contenant la clé de paramètres pour l'instance actuelle du contrôle.

Remarques

Utilisez la propriété pour lever l’ambiguïté SettingsKey des groupes de propriétés des paramètres d’application lorsqu’il existe plusieurs instances de la même classe wrapper. Par exemple, si un contrôle contient une classe wrapper associée, le fait de placer plusieurs instances du même contrôle dans la même application entraîne généralement plusieurs instances de la classe wrapper. Une clé de paramètres n’est requise que lorsque les données de configuration diffèrent selon instance , par exemple, l’emplacement des contrôles positionnés dynamiquement.

Les règles générales suivantes s’appliquent à l’utilisation de SettingsKey:

• Un contrôle, comme n’importe quelle classe, peut contenir zéro ou plusieurs classes de paramètres d’application, dérivées de ApplicationSettingsBase. Chaque classe de paramètres contient sa propre ApplicationSettingsBase.SettingsKey propriété, ce qui permet de lever l’ambiguïté de plusieurs instances de cette classe.

• Un contrôle doit séparer ses données par instance et ses données partagées en différentes classes de paramètres.

• Pour un contrôle avec des données de configuration par instance, l’accesseur get de la SettingsKey propriété doit être défini par défaut sur le Name du contrôle. Dans la plupart des cas, le nom du contrôle est unique au sein d’une application. Si le contrôle contient uniquement des données de configuration partagées, get doit avoir la nullvaleur par défaut .

• L’accesseur set de cette propriété doit être implémenté pour faire la distinction entre les classes de paramètres contenant par instance et les données de configuration partagées. Pour chaque classe de paramètres contenant des données par instance, set doit simplement passer à la ApplicationSettingsBase.SettingsKey propriété de la classe settings. Pour les classes de paramètres contenant des données partagées, set ne doivent effectuer aucune action pour cette classe de paramètres.

Voir aussi

• SaveComponentSettings()
• SettingsKey
• Paramètres d'application pour les contrôles personnalisés