IPersistComponentSettings.SettingsKey Egenskap

Definition

Namnområde:
System.Configuration
Sammansättning:
System.dll

Hämtar eller anger värdet för programinställningsnyckeln för den aktuella instansen av kontrollen.

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

Egenskapsvärde

String

En String som innehåller inställningsnyckeln för den aktuella instansen av kontrollen.

Kommentarer

Använd egenskapen SettingsKey för att skilja grupper av egenskaper för programinställningar när det finns flera instanser av samma omslutningsklass. Om en kontroll till exempel innehåller en associerad omslutningsklass resulterar placering av flera instanser av samma kontroll i samma program vanligtvis i flera instanser av omslutningsklassen. En inställningsnyckel krävs endast när konfigurationsdata skiljer sig åt per instans. till exempel platsen för dynamiskt placerade kontroller.

Följande allmänna regler gäller för användning av SettingsKey:

  • En kontroll, precis som vilken klass som helst, kan innehålla noll eller fler klasser för programinställningar som härleds från ApplicationSettingsBase. Varje inställningsklass innehåller en egen ApplicationSettingsBase.SettingsKey egenskap som gör det enklare att skilja flera instanser av den klassen åt.

  • En kontroll bör separera sina data per instans och dess delade data i olika inställningsklasser.

  • För en kontroll med alla konfigurationsdata get per instans bör egenskapens SettingsKey åtkomst som standard vara Name kontrollens. I de flesta fall är namnet på kontrollen unikt i ett program. Om kontrollen endast innehåller delade konfigurationsdata get bör standardvärdet vara null.

  • Accessorn set för den här egenskapen bör implementeras för att skilja mellan inställningsklasser som innehåller data per instans och delad konfiguration. För varje inställningsklass som innehåller data set per instans bör du bara gå vidare till ApplicationSettingsBase.SettingsKey egenskapen för inställningsklassen. För inställningsklasser som innehåller delade data set bör du inte utföra någon åtgärd för den inställningsklassen.

Gäller för

Se även