Jak zapisać niestandardową klasę dla ustawień użytkownika za pomocą ApplicationSettingsBase?

Question

Próbuję zapisać niestandardową klasę dla ustawień użytkownika, ale bez większego powodzenia.

Stworzyłem projekt testowy w Visual Studio 2010 ze strukturą Target = ".NET Framework 4". Główny formularz ma dwa pola tekstowe do wyświetlania i edycji zwykłego ciągu testowego oraz pole "Tytuł" z mojej niestandardowej klasy; razem z dwoma przyciskami do załadowania i zapisania ustawień.

Wreszcie dodałem dwa ustawienia "TestString" (zwykła wartość ciągu) i TestData (typ MyDataClass - zrobiłem to w zakładce Properties.Settings projektu, wybierając "Browse ..." z listy rozwijanej Type, a następnie ręcznie wpisując "MyUserSettingsTest.MyDataClass" w polu "Wybrany typ", ponieważ początkowo nie pojawił się na liście dostępnych typów, ale następnie robi to.)

Po uruchomieniu aplikacji i kliknięciu Ustawienia obciążenia procedura obsługi zdarzeń wczytuje string i MyData lub, jeśli to się nie powiedzie, tworzy nowe wystąpienie MyDataClass. Mogę następnie edytować zwykły ciąg znaków i testować tytuł danych w formularzu i kliknąć SaveSettings. Jeśli następnie ponownie edytuję wartości, kliknij LoadSettings ponownie, ostatnio zapisane wartości są przywracane zgodnie z oczekiwaniami dla obu wartości. Jak na razie dobrze.

Problem polega na tym, że po wyjściu z aplikacji i ponownym jej uruchomieniu zwykły ciąg testowy zostanie przywrócony, ale obiekt MyData nie jest! Oczywiście, kod zachowuje MyData do pamięci ok, ale nie do stałego sklepu?

Główną formą jest kod:

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(); 
     } 
    } 
} 

Mój testowy kod klasy danych:

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; } 
     } 
    } 
} 

Nie wiem, czy jest to pomocne, ale plik generowane automatycznie app.config (która zawiera ustawienie TestString, ale NIE TestData !!?) to:

<?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> 

Automatycznie wygenerowane Plik Settings.Designer.cs jest:

//------------------------------------------------------------------------------ 
// <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; 
     } 
    } 
} 
} 

Proszę może ktoś mi powiedzieć co robię źle lub co dodatkowo muszę zrobić, aby moje niestandardową klasę utrzymują się do ustawień użytkownika prawidłowo.

Answer 1

Zapisz swój niestandardowy obiekt jako ciąg serializowany. Następnie wystarczy zapisać ciąg znaków. Na przykład użyj Json .NET JsonConverter do serializacji i deserializacji obiektów.

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

Następnie można odczytać go z powrotem jak to

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