ClientSettingsProvider Класс

Определение

Пространство имен:

System.Web.ClientServices.Providers

Сборка:

System.Web.Extensions.dll

Позволяет Windows-приложениям получать параметры пользователя из службы веб-параметров.

public ref class ClientSettingsProvider : System::Configuration::SettingsProvider, System::Configuration::IApplicationSettingsProvider

[System.Security.SecurityCritical]
public class ClientSettingsProvider : System.Configuration.SettingsProvider, System.Configuration.IApplicationSettingsProvider

[<System.Security.SecurityCritical>]
type ClientSettingsProvider = class
    inherit SettingsProvider
    interface IApplicationSettingsProvider

Public Class ClientSettingsProvider
Inherits SettingsProvider
Implements IApplicationSettingsProvider

Наследование

Object

ProviderBase

SettingsProvider

ClientSettingsProvider

Атрибуты

SecurityCriticalAttribute

Реализации

IApplicationSettingsProvider

Примеры

В следующем примере кода показано, как использовать это событие для отображения списка параметров, которые не были успешно сохранены.

private void AttachSettingsSavedEventHandler()
{
    ((ClientSettingsProvider)Properties.Settings.Default.Providers
        ["System.Web.ClientServices.Providers.ClientSettingsProvider"])
        .SettingsSaved +=
        new EventHandler<SettingsSavedEventArgs>(Form1_SettingsSaved);
}

private void Form1_SettingsSaved(object sender,
    SettingsSavedEventArgs e)
{
    // If any settings were not saved, display a list of them.
    if (e.FailedSettingsList.Count > 0)
    {
        String failedSettings = String.Join(
            Environment.NewLine,
            e.FailedSettingsList.ToArray());

        String message = String.Format("{0}{1}{1}{2}",
            "The following setting(s) were not saved:",
            Environment.NewLine, failedSettings);

        MessageBox.Show(message, "Unable to save settings",
            MessageBoxButtons.OK, MessageBoxIcon.Warning);
    }
}

Private WithEvents settingsProvider As ClientSettingsProvider = My.Settings _
    .Providers("System.Web.ClientServices.Providers.ClientSettingsProvider")

Private Sub Form1_SettingsSaved(ByVal sender As Object, _
    ByVal e As SettingsSavedEventArgs) _
    Handles settingsProvider.SettingsSaved

    ' If any settings were not saved, display a list of them.
    If e.FailedSettingsList.Count > 0 Then

        Dim failedSettings As String = String.Join( _
            Environment.NewLine, e.FailedSettingsList.ToArray())

        Dim message As String = String.Format("{0}{1}{1}{2}", _
            "The following setting(s) were not saved:", _
            Environment.NewLine, failedSettings)

        MessageBox.Show(message, "Unable to save settings", _
            MessageBoxButtons.OK, MessageBoxIcon.Warning)

    End If

End Sub

Комментарии

Службы клиентских приложений можно использовать для получения параметров пользователя из существующей службы веб-параметров, настроив приложение для использования ClientSettingsProvider класса . После настройки можно получить и задать пользовательские параметры с помощью класса параметров приложения, производного от ApplicationSettingsBase и настроенного ClientSettingsProvider для использования класса . Вы можете использовать Visual Studio для создания Settings класса для проекта (доступ к как Properties.Settings.Default в C# и My.Settings в Visual Basic). Дополнительные сведения о параметрах приложения см. в разделе Общие сведения о параметрах приложения.

Текущий ClientSettingsProvider объект можно получить с помощью ApplicationSettingsBase.Providers свойства , используя полное ClientSettingsProvider имя класса в качестве ключа. Поставщик также можно получить с помощью SettingsLoadedEventArgs.Provider свойства при обработке ApplicationSettingsBase.SettingsLoaded события.

Примечание

Этот класс содержит SecurityCriticalAttribute на уровне класса , который применяется ко всем членам класса . Исключение во время выполнения возникает, если непосредственный вызывающий объект является прозрачным с точки зрения безопасности или частично доверенным. Дополнительные сведения о критически важных для безопасности типах и членах см. в разделе Security-Transparent Code, уровень 2.

Примечание

Этот класс содержит требование наследования на уровне класса, которое применяется ко всем членам. Возникает SecurityException , если производный класс не имеет разрешения с полным доверием. Дополнительные сведения о требованиях к безопасности см. в разделе Требования ссылок и Требования наследования.

Конструкторы

ClientSettingsProvider()

Инициализирует новый экземпляр класса ClientSettingsProvider.

Свойства

ApplicationName	Это свойство не используется данным классом.
Description	Возвращает краткое, понятное описание, подходящее для отображения в инструментах администрирования или других пользовательских интерфейсах (UI). (Унаследовано от ProviderBase)
Name	Возвращает понятное имя, используемое для ссылки на поставщика во время конфигурирования. (Унаследовано от ProviderBase)
ServiceUri	Возвращает или задает расположение службы веб-параметров.

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetPreviousVersion(SettingsContext, SettingsProperty)	Возвращает предыдущую версию заданного свойства.
GetPropertyMetadata(String)	Возвращает набор метаданных для всех свойств, полученных из заданной службы веб-параметров.
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	Возвращает коллекцию значений свойства параметров для указанного экземпляра приложения и группы свойств параметров.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
Initialize(String, NameValueCollection)	Инициализирует этот поставщик.
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
Reset(SettingsContext)	Восстанавливает значения по умолчанию для всех параметров пользователя.
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	Задает значения указанной группы параметров свойств.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Upgrade(SettingsContext, SettingsPropertyCollection)	Этот метод не используется данным классом.

События

SettingsSaved

Возникает после попытки поставщика параметров сохранить значения свойства в службе веб-параметров.

См. также раздел

• Providers
• SettingsLoaded
• Службы клиентских приложений
• Общие сведения о параметрах приложений
• Практическое руководство. Создание параметров приложения