IPersistComponentSettings.SettingsKey Eigenschaft
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ruft den Wert des Schlüssels der Anwendungseinstellungen für die aktuelle Instanz des Steuerelements ab oder legt diesen fest.
public:
property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };public string SettingsKey { get; set; }member this.SettingsKey : string with get, setPublic Property SettingsKey As StringEigenschaftswert
Ein String, der den Schlüssel der Einstellungen der aktuellen Instanz des Steuerelements enthält.
Hinweise
Verwenden Sie die SettingsKey -Eigenschaft, um Gruppen von Anwendungseinstellungseigenschaften zu trennen, wenn mehrere Instanzen derselben Wrapperklasse vorhanden sind. Wenn ein Steuerelement beispielsweise eine zugeordnete Wrapperklasse enthält, führt das Platzieren mehrerer Instanzen desselben Steuerelements in derselben Anwendung in der Regel zu mehreren Instanzen der Wrapperklasse. Ein Einstellungsschlüssel ist nur erforderlich, wenn sich die Konfigurationsdaten auf instance Basis unterscheiden, z. B. der Speicherort dynamisch positionierter Steuerelemente.
Die folgenden allgemeinen Regeln gelten für die Verwendung von SettingsKey:
Ein Steuerelement kann wie jede Klasse null oder mehr Anwendungseinstellungsklassen enthalten, die von abgeleitet werden ApplicationSettingsBase. Jede Einstellungsklasse enthält eine eigene ApplicationSettingsBase.SettingsKey Eigenschaft, die dazu beiträgt, mehrere Instanzen dieser Klasse zu unterscheiden.
Ein Steuerelement sollte seine instance Daten und die freigegebenen Daten in verschiedene Einstellungsklassen trennen.
Bei einem Steuerelement mit beliebigen instance Konfigurationsdaten sollte der
getAccessor der SettingsKey -Eigenschaft standardmäßig auf den Name des -Steuerelements festgelegt werden. In den meisten Fällen ist der Name des Steuerelements innerhalb einer Anwendung eindeutig. Wenn das Steuerelement nur freigegebene Konfigurationsdaten enthält,getsollte standardmäßig festgelegt werdennull.Der
setAccessor für diese Eigenschaft sollte implementiert werden, um zwischen Einstellungsklassen zu unterscheiden, die instance- und freigegebenen Konfigurationsdaten enthalten. Für jede Einstellungsklasse, die daten pro instance enthält,setsollte einfach an die ApplicationSettingsBase.SettingsKey Eigenschaft der Einstellungsklasse übergeben werden. Für Einstellungsklassen, die freigegebene Daten enthalten,setsollte keine Aktion für diese Einstellungsklasse ausgeführt werden.
