ClientSettingsProvider 类

定义

命名空间:

System.Web.ClientServices.Providers

程序集:

System.Web.Extensions.dll

使基于 Windows 的应用程序可以从 Web 设置服务中检索用户设置。

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 类，使用客户端应用程序服务从现有 Web 设置服务检索用户设置。 配置后，可以通过派生自 ApplicationSettingsBase 的应用程序设置类获取和设置用户设置，并将其配置为使用 ClientSettingsProvider 类。 可以使用 Visual Studio 为项目生成类Settings， (在 C# 和 My.Settings Visual Basic) 中访问Properties.Settings.Default。 有关应用程序设置的详细信息，请参阅应用程序设置概述。

可以使用完全限定ClientSettingsProvider的类名作为键通过 属性检索当前 。ClientSettingsProviderApplicationSettingsBase.Providers 处理事件时ApplicationSettingsBase.SettingsLoaded，SettingsLoadedEventArgs.Provider还可以通过 属性检索提供程序。

注意

此类在类级别包含 SecurityCriticalAttribute 应用于类的所有成员的 。 如果直接调用方是安全透明的或部分受信任的，则会引发运行时异常。 有关安全关键类型和成员的详细信息，请参阅 安全透明代码级别 2。

注意

此类包含适用于所有成员的类级别的继承要求。 SecurityException当派生类没有完全信任权限时，将引发 。 有关安全要求的详细信息，请参阅 链接需求 和 继承需求。

构造函数

ClientSettingsProvider()

初始化 ClientSettingsProvider 类的新实例。

属性

ApplicationName	此类未使用此属性。
Description	获取一条简短的易懂描述，它适合在管理工具或其他用户界面 (UI) 中显示。 (继承自 ProviderBase)
Name	获得一个友好名称，用于在配置过程中引用提供程序。 (继承自 ProviderBase)
ServiceUri	获取或设置 Web 设置服务位置。

方法

Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetPreviousVersion(SettingsContext, SettingsProperty)	获取指定属性的上一版本。
GetPropertyMetadata(String)	获取从指定的 Web 设置服务检索的所有属性的元数据集合。
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	返回指定应用程序实例的设置属性值集合和设置属性组。
GetType()	获取当前实例的 Type。 (继承自 Object)
Initialize(String, NameValueCollection)	初始化提供程序。
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
Reset(SettingsContext)	将所有用户设置都重置为其默认值。
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	设置指定的属性设置组的值。
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Upgrade(SettingsContext, SettingsPropertyCollection)	此类未使用此方法。

事件

SettingsSaved

在设置提供程序尝试将属性值保存到 Web 设置服务时发生。

另请参阅

• Providers
• SettingsLoaded
• 客户端应用程序服务
• 应用程序设置概述
• 如何：创建应用程序设置