SettingsProvider Klasse

Definition

Fungiert als Basisklasse zum Ableiten benutzerdefinierter Einstellungsanbieter in der Anwendungseinstellungsarchitektur.Acts as a base class for deriving custom settings providers in the application settings architecture.

public ref class SettingsProvider abstract : System::Configuration::Provider::ProviderBase
public abstract class SettingsProvider : System.Configuration.Provider.ProviderBase
type SettingsProvider = class
    inherit ProviderBase
Public MustInherit Class SettingsProvider
Inherits ProviderBase
Vererbung
SettingsProvider
Abgeleitet

Hinweise

Ein Einstellungs Anbieter definiert den Mechanismus zum Speichern von Konfigurationsdaten, die in der Architektur der Anwendungseinstellungen verwendet werden.A settings provider defines the mechanism for storing configuration data used in the application settings architecture. Die .NET Framework enthält einen einzelnen Standard Einstellungs Anbieter LocalFileSettingsProvider,, der Konfigurationsdaten im lokalen Dateisystem speichert.The .NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. Sie können jedoch auch alternative Speicher Mechanismen erstellen, indem Sie von der SettingsProvider abstrakten-Klasse ableiten.However, you can create alternate storage mechanisms by deriving from the abstract SettingsProvider class. Der Anbieter, den eine Wrapper Klasse verwendet, wird bestimmt, indem die Wrapper Klasse SettingsProviderAttributemit dem versehen wird.The provider that a wrapper class uses is determined by decorating the wrapper class with the SettingsProviderAttribute. Wenn dieses Attribut nicht angegeben wird, wird der Standard LocalFileSettingsProviderWert,, verwendet.If this attribute is not provided, the default, LocalFileSettingsProvider, is used.

Wenn Sie einen benutzerdefinierten Einstellungs Anbieter erstellen, müssen Sie mindestens Implementierungen für die drei Methoden dieser Klasse bereitstellen: GetPropertyValues, SetPropertyValues und ApplicationName.When you create a custom settings provider, at minimum, you must provide implementations for the three methods of this class: GetPropertyValues, SetPropertyValues and ApplicationName.

Bei Client Anwendungen können Sie einem benutzerdefinierten Anbieter eine standardisiertere Funktionalität hinzufügen, indem IApplicationSettingsProvider Sie auch die-Schnittstelle implementieren.For client applications, you can add more standardized functionality to a custom provider by also implementing the IApplicationSettingsProvider interface. Diese Schnittstelle spiegelt die in der ApplicationSettingsBase -Klasse gefundenen Methoden wider, die hauptsächlich Versions Unterstützung ermöglicht.This interface mirrors methods found in the ApplicationSettingsBase class, which mainly enables versioning support.

In der Regel sollten Sie Einstellungs Anbieter so entwerfen, dass Sie eine einzelne Instanz aufweisen, um Speicherressourcen Konflikte zu vermeiden.Typically, you should design settings providers to be single-instanced to avoid storage resource contention. Anbieter sollten auch Thread sicher sein, da Sie gleichzeitig von mehreren Wrapper Instanzen in einer einzelnen Anwendungsdomäne oder von mehreren Anwendungen in verschiedenen Domänen aufgerufen werden können.Providers should also be thread-safe because they can be called simultaneously from multiple wrapper instances in a single application domain or from multiple applications in different domains.

Ein Einstellungs Anbieter muss mindestens drei Attribute ApplicationScopedSettingAttributeerkennen:, UserScopedSettingAttributeund DefaultSettingValueAttribute.At minimum, a settings provider must recognize three attributes - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, and DefaultSettingValueAttribute. Eine vollständige Liste der Attribute, die auf Anwendungseinstellungen angewendet werden können, finden Sie unter Attribute für Anwendungseinstellungen.For a full listing of attributes that can be applied to application settings, see Application Settings Attributes. Ein benutzerdefinierter Einstellungs Anbieter sollte auf folgende Weise auf Einstellungs Eigenschaften angewendete Attribute auflösen:A custom setting provider should resolve attributes applied to settings properties in the following manner:

  1. Wenn der Anbieter die vom Attribut implizierte Anforderung erfüllen kann, sollte dies natürlich der Fall sein.If the provider can fulfill the request implied by the attribute, obviously it should do so.

  2. Wenn der Anbieter die Anforderung nicht erfüllen kann, sollte er im Hintergrund ignoriert werden.If the provider cannot fulfill the request, it should ignore it silently.

  3. , Wenn zwei oder mehr Eigenschaften einen Konflikt verursachen. zum Beispiel eine-Eigenschaft, die sowohl ApplicationScopedSettingAttribute mit als auch UserScopedSettingAttributemit versehen wird. der ConfigurationExceptionAnbieter sollte eine auslösen.If two or more properties conflict; for example, a property being decorated with both ApplicationScopedSettingAttribute and UserScopedSettingAttribute; the provider should throw a ConfigurationException.

Konstruktoren

SettingsProvider()

Initialisiert eine Instanz der SettingsProvider-Klasse.Initializes an instance of the SettingsProvider class.

Eigenschaften

ApplicationName

Ruft den Namen der aktuell ausgeführten Anwendung ab oder legt diesen fest.Gets or sets the name of the currently running application.

Description

Ruft eine kurze, benutzerfreundliche Beschreibung ab, die für die Anzeige in Verwaltungstools oder anderen Benutzeroberflächen geeignet ist.Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Geerbt von ProviderBase)
Name

Ruft den Anzeigennamen ab, der verwendet wird, um während der Konfiguration auf den Anbieter zu verweisen.Gets the friendly name used to refer to the provider during configuration.

(Geerbt von ProviderBase)

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Gibt die Auflistung der Einstellungseigenschaftswerte für die angegebene Anwendungsinstanz und Einstellungseigenschaftengruppe zurück.Returns the collection of settings property values for the specified application instance and settings property group.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
Initialize(String, NameValueCollection)

Initialisiert den Konfigurations-Generator.Initializes the configuration builder.

(Geerbt von ProviderBase)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Legt die Werte der angegebenen Gruppe von Eigenschafteneinstellungen fest.Sets the values of the specified group of property settings.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch