IPersistComponentSettings.SettingsKey Właściwość
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Pobiera lub ustawia wartość klucza ustawień aplikacji dla bieżącego wystąpienia kontrolki.
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
Wartość właściwości
Element String zawierający klucz ustawień dla bieżącego wystąpienia kontrolki.
Uwagi
SettingsKey Użyj właściwości , aby uściślić grupy właściwości ustawień aplikacji, gdy istnieje wiele wystąpień tej samej klasy otoki. Jeśli na przykład kontrolka zawiera skojarzona klasę otoki, umieszczenie wielu wystąpień tej samej kontrolki w tej samej aplikacji zwykle spowoduje wiele wystąpień klasy otoki. Klucz ustawień jest wymagany tylko wtedy, gdy dane konfiguracji różnią się w zależności od wystąpienia; na przykład lokalizacja dynamicznie rozmieszczonych kontrolek.
Następujące ogólne reguły mają zastosowanie do używania elementu SettingsKey:
Kontrolka, podobnie jak każda klasa, może zawierać zero lub więcej klas ustawień aplikacji, pochodzących z ApplicationSettingsBaseklasy . Każda klasa ustawień zawiera własną ApplicationSettingsBase.SettingsKey właściwość, która pomaga uściślać wiele wystąpień tej klasy.
Kontrolka powinna oddzielić dane poszczególnych wystąpień i udostępnione dane do różnych klas ustawień.
W przypadku kontrolki z dowolnymi danymi
get
konfiguracji poszczególnych wystąpień akcesor SettingsKey właściwości powinien być Name domyślny dla kontrolki. W większości przypadków nazwa kontrolki będzie unikatowa w aplikacji. Jeśli kontrolka zawiera tylko dane konfiguracji udostępnionej,get
powinna być domyślnie ustawiona wartośćnull
.Metody
set
dostępu dla tej właściwości należy zaimplementować w celu odróżnienia klas ustawień zawierających dane konfiguracji poszczególnych wystąpień i współużytkowanych. Dla każdej klasy ustawień zawierającej daneset
poszczególnych wystąpień należy przekazać tylko do ApplicationSettingsBase.SettingsKey właściwości klasy ustawień. W przypadku klas ustawień zawierających daneset
udostępnione nie należy wykonywać żadnej akcji dla tej klasy ustawień.