IPersistComponentSettings.SettingsKey Vlastnost

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.ConfigurationManager.dll

Balíček:

System.Configuration.ConfigurationManager v8.0.0

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 Vlastnost použijte k nejednoznačnosti skupin 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í třídy obálky. Klíč nastavení je vyžadován pouze v případě, že se konfigurační data liší na základě instance. například umístění dynamicky umístěných ovládacích prvků.

Následující obecná pravidla platí pro použití SettingsKey:

• Ovládací prvek, stejně jako každá 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á rozluštit více instancí této třídy.

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

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

• Příslušenství set pro tuto vlastnost by mělo být implementováno, aby bylo možné rozlišovat mezi třídami nastavení obsahujícími jednotlivá instance a sdílená konfigurační data. Pro každou třídu nastavení obsahující data po jednotlivých instancích set by měla pouze předávat vlastnost ApplicationSettingsBase.SettingsKey třídy nastavení. U tříd nastavení obsahujících sdílená set data by neměly provádět žádnou akci pro danou třídu nastavení.

Viz také

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