SettingsSavedEventArgs クラス

  • リファレンス

定義

名前空間:
System.Web.ClientServices.Providers
アセンブリ:
System.Web.Extensions.dll

SettingsSaved イベントのデータを提供します。

public ref class SettingsSavedEventArgs : EventArgs
public class SettingsSavedEventArgs : EventArgs
type SettingsSavedEventArgs = class
    inherit EventArgs
Public Class SettingsSavedEventArgs
Inherits EventArgs
継承
Object
EventArgs
SettingsSavedEventArgs

例

次のコード例は、このクラスを使用して、正常に保存されなかった設定の一覧を表示する方法を示しています。

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.SettingsSaved 、設定が正常に保存されなかった場合でも、設定プロバイダーが設定サービスにアクセスした後に発生します。 プロバイダーが設定を保存できない理由の 1 つは、現在のユーザーがログアウトしている場合です。プロパティを FailedSettingsList 使用して、設定が正常に保存されなかったかどうかを判断できます。

このイベントは、設定プロバイダーが設定サービスにアクセスできない場合には発生しません。この場合、プロバイダーは を WebExceptionスローします。

イベントを処理する方法の詳細については、次を参照してください。処理とイベントの発生します。

コンストラクター

SettingsSavedEventArgs(IEnumerable<String>)

SettingsSavedEventArgs クラスの新しいインスタンスを初期化します。

プロパティ

FailedSettingsList

ClientSettingsProvider がサーバーに保存できなかった設定を取得します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください