Как сохранить пользовательский класс в пользовательских настройках, используя ApplicationSettingsBase?

Question

Я пытаюсь сохранить пользовательский класс в пользовательских настройках, но без особого успеха.

Я создал тестовый проект в Visual Studio 2010 с Target framework = ".NET Framework 4". Основная форма имеет два текстовых поля для отображения и редактирования простой тестовой строки и поле "Заголовок" из моего пользовательского класса; вместе с двумя кнопками для загрузки и сохранения настроек.

Наконец, я добавил два параметра "TestString" (обычное строковое значение) и TestData (тип MyDataClass - я сделал это на вкладке Properties.Settings проекта, выбрав "Browse..." из выпадающего списка "Type", а затем вручную введя "MyUserSettingsTest"..MyDataClass "в поле" Выбранный тип ", так как он изначально не отображался в списке доступных типов, но затем появляется.)

При запуске приложения и нажатии LoadSettings обработчик событий загружает обычную строку и MyData или, если это не удается, создает новый экземпляр MyDataClass. Затем я могу отредактировать обычную строку и проверить заголовок данных в форме и нажать SaveSettings. Если я затем заново отредактирую значения, нажмите LoadSettings снова, последние сохраненные значения будут восстановлены, как и ожидалось для обоих значений. Все идет нормально.

Проблема в том, что при выходе из приложения и его повторном запуске обычная тестовая строка восстанавливается нормально, а объект MyData - нет! Очевидно, код сохраняет MyData в памяти нормально, но не в постоянном хранилище?

Основной код формы:

using System;
using System.Windows.Forms;

namespace MyUserSettingsTest
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        public MyDataClass MyData {get;set;}

        private void loadSettingsButton_Click(object sender, EventArgs e)
        {
            this.myTextBox.Text = Properties.Settings.Default.TestString;
            this.MyData = Properties.Settings.Default.TestData;

            if (this.MyData == null)
            {
                this.MyData = new MyDataClass() { ID = 1, Title = "Default New Title" };
            }

            this.myDataTitleTextBox.Text = this.MyData.Title;
        }

        private void saveSettingsButton_Click(object sender, EventArgs e)
        {
            this.MyData.Title = this.myDataTitleTextBox.Text;

            Properties.Settings.Default.TestString = this.myTextBox.Text;
            Properties.Settings.Default.TestData = this.MyData;
            Properties.Settings.Default.Save();
        }
    }
}

Мой код класса тестовых данных:

using System.Configuration;

namespace MyUserSettingsTest
{
    public class MyDataClass : ApplicationSettingsBase
    {
        public MyDataClass()
        {
        }

        private int _id;
        private string _title;

        [UserScopedSetting()]
        [SettingsSerializeAs(SettingsSerializeAs.Xml)] 
        public int ID
        {
            get { return _id; }
            set { _id = value; }
        }

        [UserScopedSetting()]
        [SettingsSerializeAs(SettingsSerializeAs.Xml)] 
        public string Title
        {
            get { return _title; }
            set { _title = value; }
        }
    }
}

Я не знаю, поможет ли это, но автоматически сгенерированный файл app.config (который содержит параметр TestString, но НЕ TestData!!?):

<?xml version="1.0"?>
<configuration>
    <configSections>
        <sectionGroup name="userSettings" type="System.Configuration.UserSettingsGroup, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
            <section name="MyUserSettingsTest.Properties.Settings"     type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" allowExeDefinition="MachineToLocalUser" requirePermission="false"/>
        </sectionGroup>
    </configSections>
    <userSettings>
        <MyUserSettingsTest.Properties.Settings>
            <setting name="TestString" serializeAs="String">
                <value/>
            </setting>
        </MyUserSettingsTest.Properties.Settings>
    </userSettings>
<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/></startup></configuration>

Сгенерированный автоматически файл Settings.Designer.cs:

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//     Runtime Version:4.0.30319.269
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

namespace MyUserSettingsTest.Properties {


[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "10.0.0.0")]
internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase {

    private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings())));

    public static Settings Default {
        get {
            return defaultInstance;
        }
    }

    [global::System.Configuration.UserScopedSettingAttribute()]
    [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
    [global::System.Configuration.DefaultSettingValueAttribute("")]
    public string TestString {
        get {
            return ((string)(this["TestString"]));
        }
        set {
            this["TestString"] = value;
        }
    }

    [global::System.Configuration.UserScopedSettingAttribute()]
    [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
    public global::MyUserSettingsTest.MyDataClass TestData {
        get {
            return ((global::MyUserSettingsTest.MyDataClass)(this["TestData"]));
        }
        set {
            this["TestData"] = value;
        }
    }
}
}

Пожалуйста, кто-нибудь может сказать мне, что я делаю неправильно или что мне нужно сделать, чтобы мой пользовательский класс правильно сохранил пользовательские настройки.

Answer 1

Сохраните ваш пользовательский объект как сериализованную строку. Тогда вам нужно только сохранить строку. Например, используйте Json .NET JsonConverter для сериализации и десериализации объектов.

Properties.Settings.Default.TestData = JsonConvert.SerializeObject<MyDataClass>(this.MyData);

Тогда вы могли бы прочитать это обратно, как это

this.MyData = JsonConvert.DeserializeObject<MyDataClass>(Properties.Settings.Default.TestData);