IPersistComponentSettings.SettingsKey Vlastnost

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.ConfigurationManager.dll

Zdroj:

IPersistComponentSettings.cs

Získá nebo nastaví hodnotu klíče nastavení aplikace pro aktuální instanci ovládacího prvku.

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

Hodnota vlastnosti

String

A String obsahující klíč nastavení pro aktuální instanci ovládacího prvku.

Poznámky

SettingsKey Pomocí vlastnosti lze nejednoznačit skupiny vlastností nastavení aplikace, pokud existuje více instancí stejné třídy obálky. Pokud například ovládací prvek obsahuje přidruženou třídu obálky, umístění více instancí stejného ovládacího prvku do stejné aplikace obvykle způsobí více instancí obálkové třídy. Klíč nastavení se vyžaduje pouze v případě, že se konfigurační data liší v jednotlivých instancích; Například umístění dynamicky umístěných ovládacích prvků.

Následující obecná pravidla se vztahují na použití SettingsKey:

• Ovládací prvek, stejně jako jakákoli třída, může obsahovat nula nebo více tříd nastavení aplikace odvozených z ApplicationSettingsBase. Každá třída nastavení obsahuje vlastní ApplicationSettingsBase.SettingsKey vlastnost, která pomáhá nejednoznačit více instancí této třídy.

• Ovládací prvek by měl oddělit data pro jednotlivé instance a jejich sdílená data do různých tříd nastavení.

• U ovládacího prvku s libovolnými konfiguračními daty get pro jednotlivé instance by Name mělo být výchozím SettingsKey nastavením vlastnosti ovládací prvek. Ve většině případů bude název ovládacího prvku jedinečný v rámci aplikace. Pokud ovládací prvek obsahuje pouze sdílená konfigurační data, get měla by být výchozí hodnota null.

• Přístup set k této vlastnosti by měl být implementován k rozlišení mezi třídami nastavení obsahujícími jednotlivé instance a sdílenými konfiguračními daty. Pro každou třídu nastavení obsahující data pro jednotlivé instance by set měla pouze předávat vlastnost ApplicationSettingsBase.SettingsKey třídy nastavení. U tříd nastavení obsahujících sdílená data set by neměly provádět žádnou akci pro tuto třídu nastavení.

Viz také

• SaveComponentSettings()
• SettingsKey
• Nastavení aplikace pro vlastní ovládací prvky