SettingsProvider Klasa

Definicja

Działa jako klasa bazowa do wyprowadzania niestandardowych dostawców ustawień w architekturze ustawień aplikacji.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
Dziedziczenie
SettingsProvider
Pochodne

Uwagi

Dostawca ustawień definiuje mechanizm przechowywania danych konfiguracyjnych używanych w architekturze ustawień aplikacji.A settings provider defines the mechanism for storing configuration data used in the application settings architecture. .NET Framework zawiera pojedynczego domyślnego dostawcę ustawień, LocalFileSettingsProvider który przechowuje dane konfiguracji w lokalnym systemie plików.The .NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. Można jednak tworzyć alternatywne mechanizmy magazynu, wywodząc się z klasy abstrakcyjnej SettingsProvider .However, you can create alternate storage mechanisms by deriving from the abstract SettingsProvider class. Dostawca, którego używa Klasa otoki, jest określany przez dekorowania nazwy klasy otoki z SettingsProviderAttribute .The provider that a wrapper class uses is determined by decorating the wrapper class with the SettingsProviderAttribute. Jeśli ten atrybut nie zostanie podany, LocalFileSettingsProvider zostanie użyta wartość domyślna,.If this attribute is not provided, the default, LocalFileSettingsProvider, is used.

Podczas tworzenia niestandardowego dostawcy ustawień należy zapewnić implementacje dla trzech metod tej klasy: GetPropertyValues , SetPropertyValues i 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.

W przypadku aplikacji klienckich można dodać bardziej ustandaryzowaną funkcję do niestandardowego dostawcy, implementując także IApplicationSettingsProvider interfejs.For client applications, you can add more standardized functionality to a custom provider by also implementing the IApplicationSettingsProvider interface. Ten interfejs odzwierciedla metody znajdujące się w ApplicationSettingsBase klasie, która głównie umożliwia obsługę wersji.This interface mirrors methods found in the ApplicationSettingsBase class, which mainly enables versioning support.

Zazwyczaj należy zaprojektować dostawców ustawień, aby można było mieć pojedyncze wystąpienie, aby uniknąć rywalizacji o zasoby magazynu.Typically, you should design settings providers to be single-instanced to avoid storage resource contention. Dostawcy powinny również być bezpieczne wątkowo, ponieważ mogą być wywoływane jednocześnie z wielu wystąpień otoki w jednej domenie aplikacji lub z wielu aplikacji w różnych domenach.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.

Co najmniej Dostawca ustawień musi rozpoznać trzy atrybuty — ApplicationScopedSettingAttribute , UserScopedSettingAttribute i DefaultSettingValueAttribute .At minimum, a settings provider must recognize three attributes - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, and DefaultSettingValueAttribute. Aby zapoznać się z pełną listą atrybutów, które można zastosować do ustawień aplikacji, zobacz atrybuty ustawień aplikacji.For a full listing of attributes that can be applied to application settings, see Application Settings Attributes. Niestandardowy dostawca ustawień powinien rozpoznawać atrybuty zastosowane do właściwości ustawień w następujący sposób:A custom setting provider should resolve attributes applied to settings properties in the following manner:

  1. Jeśli dostawca może spełnić żądanie implikowane przez atrybut, oczywiście należy to zrobić.If the provider can fulfill the request implied by the attribute, obviously it should do so.

  2. Jeśli dostawca nie może zrealizować żądania, powinien go zignorować w trybie dyskretnym.If the provider cannot fulfill the request, it should ignore it silently.

  3. Jeśli co najmniej dwie właściwości powodują konflikt; Załóżmy na przykład, że właściwość jest dekoracyjna zarówno ApplicationScopedSettingAttribute , jak i UserScopedSettingAttribute ; dostawca powinien zgłosić ConfigurationException .If two or more properties conflict; for example, a property being decorated with both ApplicationScopedSettingAttribute and UserScopedSettingAttribute; the provider should throw a ConfigurationException.

Konstruktory

SettingsProvider()

Inicjuje wystąpienie klasy SettingsProvider.Initializes an instance of the SettingsProvider class.

Właściwości

ApplicationName

Pobiera lub ustawia nazwę aktualnie uruchomionej aplikacji.Gets or sets the name of the currently running application.

Description

Pobiera krótki, przyjazny opis odpowiedni do wyświetlania w narzędziach administracyjnych lub innych interfejsach użytkownika (interfejsów użytkownika).Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Odziedziczone po ProviderBase)
Name

Pobiera przyjazną nazwę używaną do odwoływania się do dostawcy podczas konfiguracji.Gets the friendly name used to refer to the provider during configuration.

(Odziedziczone po ProviderBase)

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Zwraca kolekcję wartości właściwości ustawień dla określonego wystąpienia aplikacji i grupy właściwości ustawienia.Returns the collection of settings property values for the specified application instance and settings property group.

GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
Initialize(String, NameValueCollection)

Inicjuje konstruktora konfiguracji.Initializes the configuration builder.

(Odziedziczone po ProviderBase)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Ustawia wartości określonej grupy ustawień właściwości.Sets the values of the specified group of property settings.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też