Attribute für Anwendungseinstellungen

  • Artikel

Die Architektur der Anwendungseinstellungen bietet viele Attribute, die entweder auf die Wrapperklasse für Anwendungseinstellungen oder auf ihre einzelnen Eigenschaften angewandt werden können. Diese Attribute werden zur Laufzeit durch die Anwendungseinstellungsinfrastruktur untersucht (oft speziell durch den Einstellungsanbieter), um ihre Funktionsweise an die angegebenen Anforderungen des benutzerdefinierten Wrappers anzupassen.

In der folgenden Tabelle sind die Attribute aufgeführt, die auf die Wrapperklassen für Anwendungseinstellungen und/oder die einzelnen Eigenschaften dieser Klasse angewandt werden können. Definitionsgemäß darf nur ein Bereichsattribut – also entweder UserScopedSettingAttribute oder ApplicationScopedSettingAttribute – auf jede Einstellungseigenschaft angewandt werden.

Hinweis

Ein benutzerdefinierter Einstellungsanbieter, der von der SettingsProvider-Klasse abgeleitet ist, wird nur benötigt, um die folgenden drei Attribute zu erkennen: ApplicationScopedSettingAttribute, UserScopedSettingAttribute und DefaultSettingValueAttribute.

attribute Ziel Beschreibung
SettingsProviderAttribute Beide Gibt den Kurznamen des Einstellungsanbieters an, der für Persistenz verwendet werden soll.

Wenn dieses Attribut nicht angegeben wird, wird der Standardanbieter (LocalFileSettingsProvider) angenommen.
UserScopedSettingAttribute Beide Definiert eine Eigenschaft als Anwendungseinstellung im Benutzerbereich.
ApplicationScopedSettingAttribute Beide Definiert eine Eigenschaft als Anwendungseinstellung im Anwendungsbereich.
DefaultSettingValueAttribute Eigenschaft Gibt eine Zeichenfolge an, die vom Anbieter in den hartcodierten Standardwert für diese Eigenschaft deserialisiert werden kann.

Der LocalFileSettingsProvider benötigt dieses Attribut nicht und überschreibt jeden Wert, der von diesem Attribut bereitgestellt wird, wenn bereits ein Wert gespeichert wurde.
SettingsDescriptionAttribute Eigenschaft Stellt beschreibenden Test für eine einzelne Einstellung bereit, der in erster Linie von Laufzeit- und Entwurfszeittools verwendet wird.
SettingsGroupNameAttribute Klasse Stellt einen expliziten Namen für eine Einstellungsgruppe bereit. Wenn dieses Attribut fehlt, verwendet ApplicationSettingsBase den Wrapperklassenamen.
SettingsGroupDescriptionAttribute Klasse Stellt beschreibenden Text für eine Einstellungsgruppe bereit, der hauptsächlich von Laufzeit- und Entwurfszeittools verwendet wird.
SettingsManageabilityAttribute Beide Gibt null oder mehr verwaltbare Dienste an, die für die Einstellungsgruppe oder Eigenschaft bereitgestellt werden sollen. Die verfügbaren Dienste werden durch die SettingsManageability-Enumeration beschrieben.
SpecialSettingAttribute Eigenschaft Gibt an, dass eine Einstellung zu einer speziellen, vordefinierten Kategorie gehört, z. B. einer Verbindungszeichenfolge, die eine spezielle Verarbeitung durch den Einstellungsanbieter vorschlägt. Die vordefinierten Kategorien für dieses Attribut werden durch die SpecialSetting-Enumeration definiert.
SettingsSerializeAsAttribute Beide Gibt einen bevorzugten Serialisierungsmechanismus für eine Einstellungsgruppe oder Eigenschaft an. Die verfügbaren Serialisierungsmechanismen werden durch die SettingsSerializeAs-Enumeration definiert.
NoSettingsVersionUpgradeAttribute Eigenschaft Gibt an, dass ein Einstellungsanbieter alle Funktionen zum Anwendungsupgrade für die markierte Eigenschaft deaktivieren soll.

Klasse gibt an, dass das Attribut nur auf eine Wrapperklasse für Anwendungseinstellungen angewandt werden kann. Eigenschaft gibt an, dass das Attribut nur auf Einstellungseigenschaften angewandt werden kann. Beide gibt an, dass das Attribut auf beiden Ebenen angewandt werden kann.

Weitere Informationen