IPersistComponentSettings.SettingsKey Eigenschap

Definitie

Hiermee haalt u de waarde van de sleutel van de toepassingsinstellingen voor het huidige exemplaar van het besturingselement op of stelt u deze in.

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

Waarde van eigenschap

Een String met de instellingensleutel voor het huidige exemplaar van het besturingselement.

Opmerkingen

Gebruik de SettingsKey eigenschap om groepen toepassingsinstellingen niet eenduidig te definiëren wanneer er meerdere exemplaren van dezelfde wrapperklasse zijn. Als een besturingselement bijvoorbeeld een gekoppelde wrapper-klasse bevat, resulteert het plaatsen van meerdere exemplaren van hetzelfde besturingselement in dezelfde toepassing doorgaans in meerdere exemplaren van de wrapper-klasse. Een instellingensleutel is alleen vereist wanneer de configuratiegegevens per exemplaar verschillen; Bijvoorbeeld de locatie van dynamisch positioneerde besturingselementen.

De volgende algemene regels zijn van toepassing op het gebruik van SettingsKey:

  • Een besturingselement, zoals elke klasse, kan nul of meer toepassingsinstellingenklassen bevatten, afgeleid van ApplicationSettingsBase. Elke instellingenklasse bevat een eigen ApplicationSettingsBase.SettingsKey eigenschap, waarmee u meerdere exemplaren van die klasse ondubbelzinnig kunt maken.

  • Een besturingselement moet de gegevens per instantie en de gedeelde gegevens scheiden in verschillende instellingenklassen.

  • Voor een besturingselement met configuratiegegevens per instantie moet de get toegangsrechten van de SettingsKey eigenschap standaard worden ingesteld op het Name besturingselement. In de meeste gevallen is de naam van het besturingselement uniek binnen een toepassing. Als het besturingselement alleen gedeelde configuratiegegevens bevat, get moet dit standaard nullzijn.

  • De set accessor voor deze eigenschap moet worden geïmplementeerd om onderscheid te maken tussen instellingenklassen die per exemplaar en gedeelde configuratiegegevens bevatten. Voor elke instellingenklasse die gegevens per instantie bevat, set moet u alleen doorgeven aan de ApplicationSettingsBase.SettingsKey eigenschap van de instellingenklasse. Voer voor instellingenklassen met gedeelde gegevens set geen actie uit voor die instellingenklasse.

Van toepassing op

Zie ook