ApplicationSettingsBase.SettingsKey Egenskap
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Hämtar eller anger inställningsnyckeln för programinställningsgruppen.
public:
property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }[<System.ComponentModel.Browsable(false)>]
member this.SettingsKey : string with get, setPublic Property SettingsKey As StringEgenskapsvärde
En String som innehåller inställningsnyckeln för den aktuella inställningsgruppen.
- Attribut
Kommentarer
Egenskapen SettingsKey tillhandahålls för att aktivera klientkod, och i synnerhet inställningsprovidern, för att skilja mellan flera instanser av samma programinställningsklass.
Om inte inställningshanteringsklassen har utformats med hjälp av singleton-mönstret kan det finnas flera instanser av samma programinställningsklass i ett enda program. Värdet SettingsKey för ska anges enligt hur egenskapsvärdena ska delas.
Om omslutningens inställningsegenskaper är avsedda att delas mellan alla instanser av omslutningen i samma program bör du SettingsKey ha samma värde i alla instanser. Det här är standardbeteendet för ApplicationSettingsBase klassen.
Om inställningsegenskaperna för omslutningen är avsedda att vara per instans bör du SettingsKey ha ett unikt värde för varje instans. Med ApplicationSettingsBase(String) konstruktorns version kan du initiera SettingsKey till en unik sträng.
Egenskapen ger däremot Context tips till inställningsprovidern så att den kan bevara värden på ett effektivt och ordnat sätt.
Klassen SettingChangingEventArgs innehåller en liknande SettingKey egenskap som hjälper dig att identifiera källan till SettingChanging händelsen.