ApplicationSettingsBase クラス

リファレンス

定義

名前空間:: System.Configuration

アセンブリ:: System.Configuration.ConfigurationManager.dll

アセンブリ:: System.dll

パッケージ:: System.Configuration.ConfigurationManager v6.0.0

パッケージ:: System.Configuration.ConfigurationManager v7.0.0

パッケージ:: System.Configuration.ConfigurationManager v8.0.0

パッケージ:: System.Configuration.ConfigurationManager v9.0.0-preview.2.24128.5

ソース:: ApplicationSettingsBase.cs

ソース:: ApplicationSettingsBase.cs

ソース:: ApplicationSettingsBase.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

Windows フォームアプリケーションでアプリケーション設定機能を実装する、具象ラッパークラスを派生する基本クラスとして機能します。

public ref class ApplicationSettingsBase abstract : System::Configuration::SettingsBase, System::ComponentModel::INotifyPropertyChanged

public abstract class ApplicationSettingsBase : System.Configuration.SettingsBase, System.ComponentModel.INotifyPropertyChanged

type ApplicationSettingsBase = class
    inherit SettingsBase
    interface INotifyPropertyChanged

Public MustInherit Class ApplicationSettingsBase
Inherits SettingsBase
Implements INotifyPropertyChanged

継承: Object

SettingsBase
ApplicationSettingsBase

実装: INotifyPropertyChanged

例

次のコード例は、アプリケーション設定を使用して、場所、サイズ、背景色、タイトルバーテキストというメインフォームの属性を保持する方法を示しています。これらの属性はすべて、クラスの FormSettings 1 つのアプリケーション設定プロパティとして、それぞれ、FormSizeFormBackColor、および FormTextという名前FormLocationで保持されます。および Size をFormText除くすべてのデータは、関連付けられているフォームプロパティにバインドされ、を使用して既定の設定値がDefaultSettingValueAttribute適用されます。

フォームには、次の名前と関数を持つ 4 つの子コントロールが含まれています。

[色] 共通ダイアログボックスを表示するために使用されるという名前btnBackColorのボタン。
アプリケーション設定に使用される Reload という名前btnReloadのボタン。
アプリケーション設定に使用される Reset という名前btnResetのボタン。
プログラムに関する状態情報を表示するために使用されるという名前 tbStatus のテキストボックス。

アプリケーションを実行するたびに、フォームのタイトルテキストにピリオド文字が追加されます。

このコード例では、という名前のクラスをColorDialog持つ Form と、というcolorDialog1名前tbStatusのStatusStripコントロールがToolStripStatusLabel必要です。さらに、およびという名前btnReloadbtnResetの 3 つのButtonオブジェクトが必要ですbtnBackColor。


#using <System.dll>
#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::Drawing;
using namespace System::Configuration;
using namespace System::Windows::Forms;

namespace AppSettingsSample
{
    //Application settings wrapper class
    ref class FormSettings sealed: public ApplicationSettingsBase
    {
    public:
        [UserScopedSettingAttribute()]
        property String^ FormText
        {
            String^ get()
            {
                return (String^)this["FormText"];
            }
            void set( String^ value )
            {
                this["FormText"] = value;
            }
        }

    public:
        [UserScopedSettingAttribute()]
        [DefaultSettingValueAttribute("0, 0")]
        property Point FormLocation
        {
            Point get()
            {
                return (Point)(this["FormLocation"]);
            }
            void set( Point value )
            {
                this["FormLocation"] = value;
            }
        }

    public:
        [UserScopedSettingAttribute()]
        [DefaultSettingValueAttribute("225, 200")]
        property Size FormSize
        {
            Size get()
            {
                return (Size)this["FormSize"];
            }
            void set( Size value )
            {
                this["FormSize"] = value;
            }
        }

    public:
        [UserScopedSettingAttribute()]
        [DefaultSettingValueAttribute("LightGray")]
        property Color FormBackColor
        {
            Color get()
            {
                return (Color)this["FormBackColor"];
            }
            void set(Color value)
            {
                this["FormBackColor"] = value;
            }
        }

    };

    ref class AppSettingsForm : Form
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
    private:
        System::ComponentModel::IContainer^ components;

        /// <summary>
        /// Clean up any resources being used. The Dispose(true) 
        /// pattern for embedded objects is implemented with this
        /// code that just contains a destructor 
        /// </summary>
    public:
        ~AppSettingsForm()
        {
            if (components != nullptr)
            {
                delete components;
            }
        }

#pragma region Windows Form Designer generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
    private:
        void InitializeComponent()
        {
            this->components = nullptr;
            this->colorDialog = gcnew System::Windows::Forms::ColorDialog();
            this->backColorButton = gcnew System::Windows::Forms::Button();
            this->resetButton = gcnew System::Windows::Forms::Button();
            this->statusDisplay = gcnew System::Windows::Forms::TextBox();
            this->reloadButton = gcnew System::Windows::Forms::Button();
            this->SuspendLayout();
            //
            // backColorButton
            //
            this->backColorButton->Location = System::Drawing::Point(26, 24);
            this->backColorButton->Name = "backColorButton";
            this->backColorButton->Size = System::Drawing::Size(159, 23);
            this->backColorButton->TabIndex = 0;
            this->backColorButton->Text = "Change Background Color";
            this->backColorButton->Click += gcnew System::EventHandler
                (this,&AppSettingsForm::BackColorButton_Click);
            //
            // resetButton
            //
            this->resetButton->Location = System::Drawing::Point(26, 90);
            this->resetButton->Name = "resetButton";
            this->resetButton->Size = System::Drawing::Size(159, 23);
            this->resetButton->TabIndex = 1;
            this->resetButton->Text = "Reset to Defaults";
            this->resetButton->Click += gcnew System::EventHandler
                (this,&AppSettingsForm::ResetButton_Click);
            //
            // statusDisplay
            //
            this->statusDisplay->Location = System::Drawing::Point(26, 123);
            this->statusDisplay->Name = "statusDisplay";
            this->statusDisplay->Size = System::Drawing::Size(159, 20);
            this->statusDisplay->TabIndex = 2;
            //
            // reloadButton
            //
            this->reloadButton->Location = System::Drawing::Point(26, 57);
            this->reloadButton->Name = "reloadButton";
            this->reloadButton->Size = System::Drawing::Size(159, 23);
            this->reloadButton->TabIndex = 3;
            this->reloadButton->Text = "Reload from Storage";
            this->reloadButton->Click += gcnew System::EventHandler
                (this,&AppSettingsForm::ReloadButton_Click);
            //
            // AppSettingsForm
            //
            this->ClientSize = System::Drawing::Size(217, 166);
            this->Controls->Add(this->reloadButton);
            this->Controls->Add(this->statusDisplay);
            this->Controls->Add(this->resetButton);
            this->Controls->Add(this->backColorButton);
            this->Name = "AppSettingsForm";
            this->Text = "App Settings";
            this->FormClosing += gcnew
                System::Windows::Forms::FormClosingEventHandler
                (this,&AppSettingsForm::AppSettingsForm_FormClosing);
            this->Load += gcnew System::EventHandler(this,
                &AppSettingsForm::AppSettingsForm_Load);
            this->ResumeLayout(false);
            this->PerformLayout();

        }

#pragma endregion

    private:
        System::Windows::Forms::ColorDialog^ colorDialog;

        System::Windows::Forms::Button^ backColorButton;

        System::Windows::Forms::Button^ resetButton;

        System::Windows::Forms::TextBox^ statusDisplay;

        System::Windows::Forms::Button^ reloadButton;



        FormSettings ^ formSettings;

    public:
        AppSettingsForm()
        {
            formSettings = gcnew FormSettings;
            InitializeComponent();
        }

    private:
        void AppSettingsForm_Load(Object^ sender, EventArgs^ e)
        {
            //Associate settings property event handlers.
            formSettings->SettingChanging += gcnew SettingChangingEventHandler(
                this, &AppSettingsForm::FormSettings_SettingChanging);
            formSettings->SettingsSaving += gcnew SettingsSavingEventHandler(
                this,&AppSettingsForm::FormSettings_SettingsSaving);

            //Data bind settings properties with straightforward associations.
            Binding^ backColorBinding = gcnew Binding("BackColor", 
                formSettings, "FormBackColor", true, 
                DataSourceUpdateMode::OnPropertyChanged);
            this->DataBindings->Add(backColorBinding);
            Binding^ sizeBinding = gcnew Binding("Size", formSettings,
                "FormSize", true, DataSourceUpdateMode::OnPropertyChanged);
            this->DataBindings->Add(sizeBinding);
            Binding^ locationBinding = gcnew Binding("Location", formSettings,
                "FormLocation", true, DataSourceUpdateMode::OnPropertyChanged);
            this->DataBindings->Add(locationBinding);

            //For more complex associations, manually assign associations.
            String^ savedText = formSettings->FormText;
            //Since there is no default value for FormText.
            if (savedText != nullptr)
            {
                this->Text = savedText;
            }
        }

    private:
        void AppSettingsForm_FormClosing(Object^ sender,
            FormClosingEventArgs^ e)
        {
            //Synchronize manual associations first.
            formSettings->FormText = this->Text + '.';
            formSettings->Save();
        }

    private:
        void BackColorButton_Click(Object^ sender, EventArgs^ e)
        {
            if (::DialogResult::OK == colorDialog->ShowDialog())
            {
                Color color = colorDialog->Color;
                this->BackColor = color;
            }
        }

    private:
        void ResetButton_Click(Object^ sender, EventArgs^ e)
        {
            formSettings->Reset();
            this->BackColor = SystemColors::Control;
        }

    private:
        void ReloadButton_Click(Object^ sender, EventArgs^ e)
        {
            formSettings->Reload();
        }

    private:
        void FormSettings_SettingChanging(Object^ sender,
            SettingChangingEventArgs^ e)
        {
            statusDisplay->Text = e->SettingName + ": " + e->NewValue;
        }

    private:
        void FormSettings_SettingsSaving(Object^ sender,
            CancelEventArgs^ e)
        {
            //Should check for settings changes first.
            ::DialogResult^ dialogResult = MessageBox::Show(
                "Save current values for application settings?",
                "Save Settings", MessageBoxButtons::YesNo);
            if (::DialogResult::No == dialogResult)
            {
                e->Cancel = true;
            }
        }
    };

partial class Form1 : Form
{
    private FormSettings frmSettings1 = new FormSettings();

    public Form1()
    {
        InitializeComponent();
    }

    private void Form1_Load(object sender, EventArgs e)
    {
        this.FormClosing += new FormClosingEventHandler(Form1_FormClosing);

        //Associate settings property event handlers.
        frmSettings1.SettingChanging += new SettingChangingEventHandler(
                                            frmSettings1_SettingChanging);
        frmSettings1.SettingsSaving += new SettingsSavingEventHandler(
                                            frmSettings1_SettingsSaving);

        //Data bind settings properties with straightforward associations.
        Binding bndBackColor = new Binding("BackColor", frmSettings1,
            "FormBackColor", true, DataSourceUpdateMode.OnPropertyChanged);
        this.DataBindings.Add(bndBackColor);
        Binding bndLocation = new Binding("Location", frmSettings1,
            "FormLocation", true, DataSourceUpdateMode.OnPropertyChanged);
        this.DataBindings.Add(bndLocation);

        // Assign Size property, since databinding to Size doesn't work well.
         this.Size = frmSettings1.FormSize;

        //For more complex associations, manually assign associations.
        String savedText = frmSettings1.FormText;
        //Since there is no default value for FormText.
        if (savedText != null)
            this.Text = savedText;
    }

    private void Form1_FormClosing(object sender, FormClosingEventArgs e)
    {
        //Synchronize manual associations first.
        frmSettings1.FormText = this.Text + '.';
        frmSettings1.FormSize = this.Size;
        frmSettings1.Save();
    }

    private void btnBackColor_Click(object sender, EventArgs e)
    {
        if (DialogResult.OK == colorDialog1.ShowDialog())
        {
            Color c = colorDialog1.Color;
            this.BackColor = c;
        }
    }

    private void btnReset_Click(object sender, EventArgs e)
    {
        frmSettings1.Reset();
        this.BackColor = SystemColors.Control;
    }

    private void btnReload_Click(object sender, EventArgs e)
    {
        frmSettings1.Reload();
    }

    void frmSettings1_SettingChanging(object sender, SettingChangingEventArgs e)
    {
        tbStatus.Text = e.SettingName + ": " + e.NewValue;
    }

    void frmSettings1_SettingsSaving(object sender, CancelEventArgs e)
    {
        //Should check for settings changes first.
        DialogResult dr = MessageBox.Show(
                        "Save current values for application settings?",
                        "Save Settings", MessageBoxButtons.YesNo);
        if (DialogResult.No == dr)
        {
            e.Cancel = true;
        }
    }
}

//Application settings wrapper class
sealed class FormSettings : ApplicationSettingsBase
{
    [UserScopedSettingAttribute()]
    public String FormText
    {
        get { return (String)this["FormText"]; }
        set { this["FormText"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("0, 0")]
    public Point FormLocation
    {
        get { return (Point)(this["FormLocation"]); }
        set { this["FormLocation"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("225, 200")]
    public Size FormSize
    {
        get { return (Size)this["FormSize"]; }
        set { this["FormSize"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("LightGray")]
    public Color FormBackColor
    {
        get { return (Color)this["FormBackColor"]; }
        set { this["FormBackColor"] = value; }
    }
}

Imports System.Configuration
Imports System.ComponentModel

Public Class Form1

    Private WithEvents frmSettings1 As New FormSettings

    Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) _
            Handles MyBase.Load
        'Settings property event handlers are associated through WithEvents 
        '  and Handles combination.

        'Data bind settings properties with straightforward associations.
        Dim bndBackColor As New Binding("BackColor", frmSettings1, "FormBackColor", _
                True, DataSourceUpdateMode.OnPropertyChanged)
        Me.DataBindings.Add(bndBackColor)
        Dim bndLocation As New Binding("Location", frmSettings1, "FormLocation", _
                True, DataSourceUpdateMode.OnPropertyChanged)
        Me.DataBindings.Add(bndLocation)

        ' Assign Size property, since databinding to Size doesn't work well.
        Me.Size = frmSettings1.FormSize

        'For more complex associations, manually assign associations.
        Dim savedText As String = frmSettings1.FormText
        'Since there is no default value for FormText.
        If (savedText IsNot Nothing) Then
            Me.Text = savedText
        End If
    End Sub

    Private Sub Form1_FormClosing_1(ByVal sender As Object, ByVal e As _
            FormClosingEventArgs) Handles MyBase.FormClosing
        'Synchronize manual associations first.
        frmSettings1.FormText = Me.Text + "."c

        ' Save size settings manually.
        frmSettings1.FormSize = Me.Size

        frmSettings1.Save()
    End Sub

    Private Sub btnBackColor_Click(ByVal sender As Object, ByVal e As EventArgs) _
            Handles btnBackColor.Click
        If System.Windows.Forms.DialogResult.OK = colorDialog1.ShowDialog() Then
            Dim c As Color = colorDialog1.Color
            Me.BackColor = c
        End If
    End Sub

    Private Sub btnReset_Click(ByVal sender As Object, ByVal e As EventArgs) _
            Handles btnReset.Click
        frmSettings1.Reset()
        Me.BackColor = SystemColors.Control
    End Sub

    Private Sub btnReload_Click(ByVal sender As Object, ByVal e As EventArgs) _
            Handles btnReload.Click
        frmSettings1.Reload()
    End Sub

    Private Sub frmSettings1_SettingChanging(ByVal sender As Object, ByVal e As _
            SettingChangingEventArgs) Handles frmSettings1.SettingChanging
        tbStatus.Text = e.SettingName & ": " & e.NewValue.ToString
    End Sub

    Private Sub frmSettings1_SettingsSaving(ByVal sender As Object, ByVal e As _
            CancelEventArgs) Handles frmSettings1.SettingsSaving
        'Should check for settings changes first.
        Dim dr As DialogResult = MessageBox.Show( _
            "Save current values for application settings?", "Save Settings", _
            MessageBoxButtons.YesNo)
        If (System.Windows.Forms.DialogResult.No = dr) Then
            e.Cancel = True
        End If
    End Sub
End Class

'Application settings wrapper class. This class defines the settings we intend to use in our application.
NotInheritable Class FormSettings
    Inherits ApplicationSettingsBase

    <UserScopedSettingAttribute()> _
    Public Property FormText() As String
        Get
            Return CStr(Me("FormText"))
        End Get
        Set(ByVal value As String)
            Me("FormText") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("0, 0")> _
    Public Property FormLocation() As Point
        Get
            Return CType(Me("FormLocation"), Point)
        End Get
        Set(ByVal value As Point)
            Me("FormLocation") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("225, 200")> _
    Public Property FormSize() As Size
        Get
            Return CType(Me("FormSize"), Size)
        End Get
        Set(ByVal value As Size)
            Me("FormSize") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("LightGray")> _
    Public Property FormBackColor() As Color
        Get
            Return CType(Me("FormBackColor"), Color)
        End Get
        Set(ByVal value As Color)
            Me("FormBackColor") = value
        End Set
    End Property
End Class

注釈

ApplicationSettingsBase は、Web ベースの SettingsBase アプリケーションで使用されるクラスに次の機能を追加します。

派生した設定ラッパークラスの属性を検出する機能。 ApplicationSettingsBase は、後で説明するように、ラッパークラスのプロパティに使用される宣言型モデルをサポートしています。
上位レベル Save と Reload メソッド。
個々の設定の正確性を確保するために処理できる追加の検証イベント。

アプリケーション設定アーキテクチャでは、設定プロパティのグループにアクセスするには、から ApplicationSettingsBase具象ラッパークラスを派生させる必要があります。ラッパークラスは、次の方法でカスタマイズします ApplicationSettingsBase 。

アクセスするすべての設定プロパティに対して、対応する厳密に型指定されたパブリックプロパティがラッパークラスに追加されます。このプロパティには、 get 読み取り/書き込みアプリケーション設定のアクセサーと set アクセサーがありますが、読み取り get 専用設定のアクセサーのみが含まれます。
設定のスコープ (アプリケーションまたはユーザー)、設定でローミングをサポートするかどうか、設定の既定値、使用する設定プロバイダーなどの設定プロパティの特性を示すには、ラッパークラスのパブリックプロパティに適切な属性を適用する必要があります。各プロパティは、または UserScopedSettingAttributeを使用してスコープをApplicationScopedSettingAttribute指定するために必要です。アプリケーションスコープの設定は、既定値 LocalFileSettingsProvider が使用されている場合は読み取り専用です。

クラスは ApplicationSettingsBase リフレクションを使用して、実行時にこれらの属性を検出します。この情報のほとんどは、ストレージ、永続化形式などを担当する設定プロバイダーレイヤーに渡されます。

アプリケーションに複数の設定ラッパークラスがある場合、各クラスは 設定グループを定義します。各グループには、次の特性があります。

グループには、任意の数または種類のプロパティ設定を含めることができます。
ラッパークラス SettingsGroupNameAttributeをで装飾するによってグループ名が明示的に設定されていない場合は、名前が自動的に生成されます。

既定では、すべてのクライアントベースのアプリケーションはを LocalFileSettingsProvider 使用してストレージを提供します。代替設定プロバイダーが必要な場合は、ラッパークラスまたはプロパティを対応する SettingsProviderAttributeで修飾する必要があります。

アプリケーション設定の使用方法の詳細については、「Windows フォームのアプリケーション設定」を参照してください。

コンストラクター

ApplicationSettingsBase()	ApplicationSettingsBase クラスのインスタンスを既定の状態に初期化します。
ApplicationSettingsBase(IComponent)	指定された所有者コンポーネントを使用して、ApplicationSettingsBase クラスのインスタンスを初期化します。
ApplicationSettingsBase(IComponent, String)	指定された所有者コンポーネントと設定キーを使用して、ApplicationSettingsBase クラスのインスタンスを初期化します。
ApplicationSettingsBase(String)	指定された設定キーを使用して、ApplicationSettingsBase クラスのインスタンスを初期化します。

プロパティ

Context	設定グループに関連付けられているアプリケーション設定のコンテキストを取得します。
IsSynchronized	オブジェクトへのアクセスが同期されている (スレッドセーフである) かどうかを示す値を取得します。 (継承元 SettingsBase)
Item[String]	指定したアプリケーション設定プロパティの値を取得または設定します。
Properties	ラッパーの設定プロパティのコレクションを取得します。
PropertyValues	プロパティ値のコレクションを取得します。
Providers	ラッパーが使用するアプリケーション設定プロバイダーのコレクションを取得します。
SettingsKey	アプリケーション設定グループの設定キーを取得または設定します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetPreviousVersion(String)	同じアプリケーションの以前のバージョンの、名前付き設定プロパティの値を返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Initialize(SettingsContext, SettingsPropertyCollection, SettingsProviderCollection)	SettingsBase オブジェクトによって使用される内部プロパティを初期化します。 (継承元 SettingsBase)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnPropertyChanged(Object, PropertyChangedEventArgs)	PropertyChanged イベントを発生させます。
OnSettingChanging(Object, SettingChangingEventArgs)	SettingChanging イベントを発生させます。
OnSettingsLoaded(Object, SettingsLoadedEventArgs)	SettingsLoaded イベントを発生させます。
OnSettingsSaving(Object, CancelEventArgs)	SettingsSaving イベントを発生させます。
Reload()	永続ストレージからアプリケーション設定プロパティ値を更新します。
Reset()	保持されているアプリケーション設定値を対応する既定のプロパティに復元します。
Save()	アプリケーション設定プロパティの現在の値を格納します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Upgrade()	アプリケーション設定を更新して、アプリケーションの最新のインストールを反映します。

イベント

PropertyChanged	アプリケーション設定プロパティの値が変更された後に発生します。
SettingChanging	アプリケーション設定プロパティの値が変更される前に発生します。
SettingsLoaded	アプリケーション設定をストレージから取得した後に発生します。
SettingsSaving	データストアに値が保存される前に発生します。

適用対象

次の方法で共有