アプリケーション情報を記録する方法 (C#)

1. ApplicationSettings

.NET, .NET Framework アプリでは、特に理由なければ通常はこの方法でアプリ情報を保存するのが最も簡単で良いでしょう。

✔ 特徴

• .NET Framework 標準機能
• コードが極端に少ない
• 自動保存・自動読み込みが可能
• WinForms / WPF 両方で使える

[評価環境]

保存例（WinForms）

private void Form1_Load(object sender, EventArgs e)
{
    if (Properties.Settings.Default.Location != Point.Empty)
    {
        this.Location = Properties.Settings.Default.Location;
        this.Size = Properties.Settings.Default.Size;
    }
}

private void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
    Properties.Settings.Default.Location = this.Location;
    Properties.Settings.Default.Size = this.Size;
    Properties.Settings.Default.Save();
}

保存例（WPF）

using System.Windows;

namespace property_settings
{
    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            // アプリケーションの設定をアップグレードする
            if (!Properties.Settings.Default.HasUpgradedSettings)
            {
                // Upgrade メソッドを呼び出して、以前のバージョンの設定を新しいバージョンに移行します
                Properties.Settings.Default.Upgrade();

                // HasUpgradedSettings は User スコープの bool 設定として追加します。
                // これにより、アプリ更新後の初回起動時だけ旧バージョンの設定を引き継げます。
                Properties.Settings.Default.HasUpgradedSettings = true;

                // 設定を保存します
                Properties.Settings.Default.Save();
            }

            // ウィンドウの位置を設定する
            this.Left = Properties.Settings.Default.position_x;
            this.Top = Properties.Settings.Default.position_y;
        }

        private void Window_Closing(object sender, System.ComponentModel.CancelEventArgs e)
        {
            // ウィンドウの位置を保存する
            Properties.Settings.Default.position_x = this.Left;
            Properties.Settings.Default.position_y = this.Top;
            Properties.Settings.Default.Save();
        }
    }
}

"AppData\Local\<Company>\<App>\<Version>\user.config" 例

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <userSettings>
        <property_settings.Properties.Settings>
            <setting name="position_x" serializeAs="String">
                <value>381.33333333333331</value>
            </setting>
            <setting name="position_y" serializeAs="String">
                <value>138</value>
            </setting>
            <setting name="HasUpgradedSettings" serializeAs="String">
                <value>True</value>
            </setting>
        </property_settings.Properties.Settings>
    </userSettings>
</configuration>

Save() は必要ですが Load() は不要（ありません）のようです。アプリケーション起動時に自動的に読み込みをやってくれているようです。

• プログラム実行中に設定読み込みしたい場合は Reload() を実行します。
• 初期値に戻したい場合は Reset() を実行します。

上記のようにとても簡単に機能を実現可能です。

2. Windows レジストリ

✔ 特徴

• 読み書きが高速
• インストール不要のポータブルアプリでも使える
• 企業アプリでよく使われる
• ただし「設定ファイルとして見えない」ためユーザー編集は面倒（regedit コマンドを使って閲覧・編集）

保存例 (c#)

using Microsoft.Win32;

RegistryKey key = Registry.CurrentUser.CreateSubKey(@"Software\MyApp");
key.SetValue("Left", this.Left);
key.SetValue("Top", this.Top);
key.SetValue("Width", this.Width);
key.SetValue("Height", this.Height);

3. JSON ファイル

✔ 特徴

• 設定ファイルが人間に読みやすい
• Git で管理しやすい
• 複数ウィンドウの設定をまとめやすい
• .NET Framework でも Newtonsoft.Json が使える

保存例 (c#)

var info = new WindowInfo
{
    Left = this.Left,
    Top = this.Top,
    Width = this.Width,
    Height = this.Height
};

string dir = Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
    "MyCompany", "MyApp");

if (!Directory.Exists(dir)) {
    Directory.CreateDirectory(dir); 
}

string path = Path.Combine(dir, "settings.json");
File.WriteAllText(path, JsonConvert.SerializeObject(info));

4. XML ファイル

✔ 特徴

• .NET Framework 時代の標準
• 設定ファイルとしてユーザーが編集しやすい
• JSON より冗長だが、企業アプリでは根強い

保存例 (c#)

var doc = new XDocument(
    new XElement("Window",
        new XElement("Left", this.Left),
        new XElement("Top", this.Top),
        new XElement("Width", this.Width),
        new XElement("Height", this.Height)
    )
);

string dir = Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
    "MyCompany", "MyApp");

if (!Directory.Exists(dir)) {
    Directory.CreateDirectory(dir); 
}

string path = Path.Combine(dir, "setting.xml");
doc.Save(path);

5. INI ファイル

✔ 特徴

• レガシーアプリとの互換性が高い
• 軽量で高速
• ただし .NET Framework では標準 API がないため P/Invoke が必要

保存例 (c#)

[DllImport("kernel32")]
private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);

string dir = Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
    "MyCompany", "MyApp");

if (!Directory.Exists(dir)) {
    Directory.CreateDirectory(dir); 
}

string path = Path.Combine(dir, "setting.ini");
WritePrivateProfileString("MainWindow", "Left", this.Left.ToString(), path);

ライセンス

本ページの情報は、特記無い限り下記 MIT ライセンスで提供されます。

参考

変更履歴

Programming Items トップページ

プライバシーポリシー