IApplicationSettingsProvider Интерфейс

Определение

Определяет расширенные возможности для поставщиков установок для клиентских приложений.Defines extended capabilities for client-based application settings providers.

public interface class IApplicationSettingsProvider
public interface IApplicationSettingsProvider
type IApplicationSettingsProvider = interface
Public Interface IApplicationSettingsProvider
Производный

Комментарии

Архитектура параметров приложения позволяет предоставить пользовательский механизм хранения для параметров приложения, создав поставщик настраиваемых параметров, который является классом, производным от SettingsProvider.The application settings architecture enables you to provide a custom storage mechanism for application settings by creating a custom settings provider, which is a class derived from SettingsProvider. Такой класс содержит базовую функциональность для хранения и извлечения свойств.Such a class contains the basic functionality for storing and retrieving properties. Однако можно добавить дополнительные стандартизованные функции, реализовав интерфейс IApplicationSettingsProvider в поставщике пользовательских параметров.However, you can add additional standardized functionality by implementing the IApplicationSettingsProvider interface in the custom settings provider. Этот интерфейс содержит три метода, которые в основном позволяют поставщику параметров более разумно управлять изменениями версий приложения.This interface contains three methods that primarily enable the settings provider to more intelligently handle application version changes. Как правило, поставщик параметров хранит параметры приложения для различных версий приложения отдельно, чтобы предвидеть следующие обстоятельства.Typically, the settings provider will store application settings for different versions of an application separately to anticipate the following circumstances:

  • Параллельное выполнение различных версий приложения.Side-by-side execution of different versions of an application.

  • Сохраняйте параметры приложения при обновлении приложения.Retaining application settings when upgrading an application.

  • Сброс параметров приложения к значениям по умолчанию для текущей используемой версии.Resetting the application settings to their default values for the currently used version.

Класс LocalFileSettingsProvider реализует интерфейс IApplicationSettingsProvider.The LocalFileSettingsProvider class implements the IApplicationSettingsProvider interface. Один и тот же набор методов, содержащихся в IApplicationSettingsProvider, также находится в классе ApplicationSettingsBase, что позволяет устанавливать стандартный коммуникационный канал между оболочкой параметров приложения и поставщиком его параметров.The same set of methods contained by IApplicationSettingsProvider is also found in the ApplicationSettingsBase class, enabling the establishment of a predefined communication channel between an application settings wrapper and its settings provider.

Примечание

Этот параметр является необязательным.This interface is optional. Если поставщик не реализует этот интерфейс, инфраструктура параметров завершится ошибкой без уведомления, если она попытается получить доступ к любому из методов, определенных этим интерфейсом.If a provider does not implement this interface, the settings infrastructure will fail without notification if it attempts to access any of the methods defined by this interface.

Методы

GetPreviousVersion(SettingsContext, SettingsProperty)

Возвращает значение указанного свойства установок для предыдущей версии того же приложения.Returns the value of the specified settings property for the previous version of the same application.

Reset(SettingsContext)

Возвращает установки, связанные с указанным приложением к значениям по умолчанию.Resets the application settings associated with the specified application to their default values.

Upgrade(SettingsContext, SettingsPropertyCollection)

Указывает поставщику, что приложение было модернизировано.Indicates to the provider that the application has been upgraded. Это дает поставщику возможность обновлять хранимые параметры подходящим образом.This offers the provider an opportunity to upgrade its stored settings as appropriate.

Применяется к

Дополнительно