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

注釈

クライアント アプリケーション サービスを使用すると、 クラスを使用するようにアプリケーションを構成することで、既存の Web 設定サービスからユーザー設定を ClientSettingsProvider 取得できます。 構成後、 クラスを使用するように 派生および構成された ApplicationSettingsBase アプリケーション設定クラスを使用して、ユーザー設定を ClientSettingsProvider 取得および設定できます。 Visual Studio を使用して、プロジェクトのクラスを生成Settingsできます (C# と My.Settings Visual Basic のようにProperties.Settings.Defaultアクセスされます)。 アプリケーション設定の詳細については、「アプリケーション設定の概要」を参照してください。

完全修飾ClientSettingsProviderクラス名をキーとして使用して、 プロパティを使用してApplicationSettingsBase.Providers現在ClientSettingsProviderの を取得できます。 イベントを処理するときに、 プロパティを SettingsLoadedEventArgs.Provider 使用してプロバイダーを ApplicationSettingsBase.SettingsLoaded 取得することもできます。

注意

このクラスには、 SecurityCriticalAttribute クラスのすべてのメンバーに適用される クラス レベルの が含まれています。 即時呼び出し元がセキュリティ透過的または部分的に信頼されている場合は、実行時例外がスローされます。 セキュリティクリティカルな型とメンバーの詳細については、「 Security-Transparent Code, Level 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
• クライアント アプリケーション サービス
• アプリケーション設定の概要
• 方法: アプリケーション設定を作成する