ApplicationSettingsBase.SettingsKey Propriété

Définition

Obtient ou définit la clé de paramètres pour le groupe de paramètres d'application.Gets or sets the settings key for the application settings group.

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }
member this.SettingsKey : string with get, set
Public Property SettingsKey As String

Valeur de propriété

String contenant la clé de paramètres pour le groupe de paramètres actuel.A String containing the settings key for the current settings group.

Attributs

Remarques

La SettingsKey propriété est fournie pour permettre au code client, et en particulier au fournisseur de paramètres, de lever l’ambiguïté entre plusieurs instances de la même classe de paramètres d’application.The SettingsKey property is provided to enable client code, and in particular the settings provider, to disambiguate between multiple instances of the same application settings class.

À moins que la classe wrapper de paramètres ne soit conçue à l’aide du modèle Singleton, il peut y avoir plusieurs instances de la même classe de paramètres d’application dans une même application.Unless the settings wrapper class is designed using the singleton pattern, there can be multiple instances of the same application settings class in a single application. La valeur de SettingsKey doit être définie en fonction de la façon dont les valeurs de propriété sont destinées à être partagées.The value of SettingsKey should be set according to how the property values are intended to be shared.

  • Si les propriétés des paramètres du wrapper sont destinées à être partagées entre toutes les instances du wrapper dans la même application, SettingsKey doivent avoir la même valeur dans toutes les instances.If the settings properties of the wrapper are intended to be shared across all instances of the wrapper in the same application, then SettingsKey should have the same value in all of the instances. Il s’agit du comportement par défaut ApplicationSettingsBase de la classe.This is the default behavior of the ApplicationSettingsBase class.

  • Si les propriétés de paramètres du wrapper sont destinées à être par instance, SettingsKey doit avoir une valeur unique pour chaque instance.If the settings properties of the wrapper are intended to be per instance, then SettingsKey should have a unique value for every instance. La ApplicationSettingsBase(String) version du constructeur vous permet d' SettingsKey initialiser une chaîne unique.The ApplicationSettingsBase(String) version of the constructor enables you to initialize SettingsKey to a unique string.

En revanche, la Context propriété fournit des indications au fournisseur de paramètres pour lui permettre de conserver les valeurs de manière efficace et ordonnée.In contrast, the Context property provides hints to the settings provider to enable it to persist values in an efficient and orderly manner.

La SettingChangingEventArgs classe contient une propriété SettingKey similaire qui permet d’identifier la source de SettingChanging l’événement.The SettingChangingEventArgs class contains a similar SettingKey property that helps identify the source of the SettingChanging event.

S’applique à

Voir aussi