UserSettingsProvider (Persistieren von UserSettings)

    • VB.NET

    Es gibt 28 Antworten in diesem Thema. Der letzte Beitrag () ist von RodFromGermany.

      UserSettingsProvider (Persistieren von UserSettings)

      Hallo Community!

      Diese kleine Projekt zeigt, wie man seine Settings an seine eigene Bedürfnisse angepasst persistiert.
      (Entstehungsgeschichte)

      Anforderung:
      Man soll die Settings genauso handhaben können, wie es der Standard im VS vorsieht:
      • automatisches Speichern bei Beenden der App.
      • mit dem Settingsdesigner Eigenschaften anlegen und Typen auswählen können
      • ApplicationSettings binden können
      • den Designer beim Binden verwenden können
      • Der Provider kann zeitgleich von mehreren Anwendungen verwendet werden - jede Anwendung hat dann seine eigene Settingsdatei!
      • ...
      Das Kernstück liegt im eigens geschriebener UserSettingsProvider, der als .dll-Projekt vorliegt.

      UserSettingsProvider

      VB.NET-Quellcode

      1. Imports System.Configuration
      2. Imports System.ComponentModel
      3. Imports System.Reflection
      4. Imports System.IO
      5. Imports System.Collections.Specialized
      6. Imports System.Runtime.Serialization.Formatters.Binary
      8. Namespace MyProvider
      9. ''' <summary>
      10. ''' Dieser Provider speichert die betroffenen Settings-Einstellungen in eine eigene .exe.config.xml-Datei.
      11. ''' Diese Datei liegt im Arbeitsverzeichnis der Anwendung.
      12. ''' HINWEISE:
      13. ''' Die ApplicationName-Property erstellt die ProduktName-Eigenschaft von der My.Application.Info.ProduktName
      14. ''' Hier sollte in den Projekteigenschaften/Anwendung/Assemblyinformationen die Eigenschaft ProduktName = AssemblyName gestellt sein!
      15. ''' </summary>
      16. ''' <remarks></remarks>
      17. Public Class UserSettingsProvider
      18. Inherits SettingsProvider
      19. Implements IApplicationSettingsProvider
      21. Private Datas As Dictionary(Of String, Object)
      22. Private Property DataFile As FileInfo
      23. Private Property AppPath As String
      25. Sub New()
      26. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      27. ApplicationName = fi.Name.Replace(fi.Extension, String.Empty)
      28. AppPath = fi.FullName.Replace(fi.Name, String.Empty)
      29. 'DataFile = New FileInfo(Path.Combine(AppPath, String.Concat(ApplicationName, ".exe.config.dat")))'weglassen
      30. Datas = New Dictionary(Of String, Object)()
      31. End Sub
      33. Public Overrides Sub Initialize(ByVal name As String, ByVal config As NameValueCollection)
      34. MyBase.Initialize(ApplicationName, config)
      35. End Sub
      37. Public Overrides Property ApplicationName() As String ' hier wird der Produktname von der Assembly angegeben
      39. Public Overrides ReadOnly Property Name As String
      40. Get
      41. Return "UserSettingsProvider"
      42. End Get
      43. End Property
      45. ''' <summary>
      46. ''' SetPropertyValues wird erst abgearbeitet, wenn ApplicationSettingsBase.Save durchgeführt wird.
      47. ''' ApplicationSettingsBase stellt sicher, dass für jeden einzelnen Provider nur seine markierten Werte herangenommen werden.
      48. ''' Egal, ob der Provider auf einer Einzel-Einstellung angesetzt ist oder ob klassenweit die Einstellung angegeben wurde.
      49. ''' Wenn Einstellungen nicht verändert wurden, müssen sie nicht gespeichert werden!
      50. ''' Anwendungsspezifische Einstellungen können nicht geändert werden und werden daher auch nicht gespeichert!
      51. ''' </summary>
      52. ''' <param name="context"></param>
      53. ''' <param name="collection"></param>
      54. Public Overrides Sub SetPropertyValues(ByVal context As SettingsContext, ByVal collection As SettingsPropertyValueCollection)
      55. For Each prpValue As SettingsPropertyValue In collection
      56. If Not prpValue.IsDirty OrElse (prpValue.SerializedValue Is Nothing) Then Continue For
      57. If IsApplicationScoped(prpValue.Property) Then Continue For
      58. Datas(prpValue.Name) = prpValue.SerializedValue
      59. Next
      60. SaveBinary(DataFile, Datas)
      61. End Sub
      63. Public Overrides Function GetPropertyValues(ByVal context As SettingsContext, ByVal collection As SettingsPropertyCollection) As SettingsPropertyValueCollection
      64. SetDataFile()
      65. If DataFile.Exists Then Datas = LoadBinary(DataFile)
      66. Dim col As New SettingsPropertyValueCollection()
      67. For Each prp As SettingsProperty In collection
      68. Dim Value As New SettingsPropertyValue(prp)
      69. If Datas.ContainsKey(prp.Name) Then Value = GetPropertyValue(prp) ' Wert von Datas einlesen
      70. col.Add(Value)
      71. Next
      72. Return col
      73. End Function
      75. ''' <summary>
      76. ''' Nur benutzerspezifische Eigenschaften sind zulässig.
      77. ''' Wenn eine Eigenschaft keinen Wert hat, wird der Defaultwert geladen.
      78. ''' </summary>
      79. ''' <param name="prp"></param>
      80. Private Function GetPropertyValue(ByVal prp As SettingsProperty) As SettingsPropertyValue
      81. Dim value As New SettingsPropertyValue(prp)
      82. If IsUserScoped(prp) Then value.SerializedValue = Datas(prp.Name)
      83. value.IsDirty = False
      84. Return value
      85. End Function
      87. ''' <summary>
      88. ''' Test auf anwendungsspezifische Eigenschaft
      89. ''' </summary>
      90. ''' <param name="prop"></param>
      91. Private Function IsApplicationScoped(ByVal prop As SettingsProperty) As Boolean
      92. Return HasSettingScope(prop, GetType(ApplicationScopedSettingAttribute))
      93. End Function
      95. ''' <summary>
      96. ''' Test auf benutzerdefinierte Eigenschaft
      97. ''' </summary>
      98. ''' <param name="prop"></param>
      99. Private Function IsUserScoped(prop As SettingsProperty) As Boolean
      100. Return HasSettingScope(prop, GetType(UserScopedSettingAttribute))
      101. End Function
      103. ''' <summary>
      104. ''' prüft auf erlaubte Einstellung, so wie es der LocalFileSettingsProvider auch macht ...
      105. ''' </summary>
      106. ''' <param name="prop"></param>
      107. ''' <param name="attributeType"></param>
      108. Private Function HasSettingScope(ByVal prop As SettingsProperty, ByVal attributeType As Type) As Boolean
      109. Dim isAppScoped As Boolean = prop.Attributes(GetType(ApplicationScopedSettingAttribute)) IsNot Nothing
      110. Dim isUserScoped As Boolean = prop.Attributes(GetType(UserScopedSettingAttribute)) IsNot Nothing
      111. If isUserScoped AndAlso isAppScoped Then Throw New ConfigurationErrorsException("BothScopeAttributes: " & prop.Name)
      112. If Not isUserScoped AndAlso Not isAppScoped Then Throw New ConfigurationErrorsException("NoScopeAttributes: " & prop.Name)
      113. Select Case True
      114. Case attributeType Is GetType(ApplicationScopedSettingAttribute) : Return isAppScoped
      115. Case attributeType Is GetType(UserScopedSettingAttribute) : Return isUserScoped
      116. Case Else : Return False
      117. End Select
      118. End Function
      120. ''' <summary>
      121. ''' Datenfile der gerade aktiven Anwendung bestimmen
      122. ''' </summary>
      123. ''' <remarks></remarks>
      124. Private Sub SetDataFile()
      125. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      126. AppPath = fi.FullName.Replace(fi.Name, String.Empty)
      127. DataFile = New FileInfo(Path.Combine(AppPath, String.Concat(ApplicationName, ".exe.config.dat")))
      128. End Sub
      130. ''' <summary>
      131. ''' Daten binär speichern
      132. ''' </summary>
      133. ''' <param name="DataFile"></param>
      134. ''' <param name="Datas"></param>
      135. Private Sub SaveBinary(DataFile As FileInfo, Datas As Dictionary(Of String, Object))
      136. SetDataFile()
      137. ' deleteLocalPathUserSettings()
      138. Using fs As Stream = File.Create(DataFile.FullName)
      139. Dim binfmt As New BinaryFormatter()
      140. binfmt.Serialize(fs, Datas)
      141. End Using
      142. End Sub
      143. ' ''' <summary>
      144. ' ''' falls der LocalUserAppDataPath vorhanden ist,
      145. ' ''' wird der Ordner mit allen untergeordneten Verzeichnissen gelöscht
      146. ' ''' </summary>
      147. ' ''' <remarks></remarks>
      148. ' Private Sub deleteLocalPathUserSettings()
      149. ' Dim di As New DirectoryInfo(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal).FilePath)
      150. ' di = di.Parent.Parent.Parent
      151. ' If di.Exists Then di.Delete(True)
      152. ' End Sub
      154. ''' <summary>
      155. ''' binäre Daten laden
      156. ''' </summary>
      157. ''' <param name="DataFile"></param>
      158. Private Function LoadBinary(DataFile As FileInfo) As Dictionary(Of String, Object)
      159. SetDataFile()
      160. Using fs As Stream = File.Open(DataFile.FullName, FileMode.Open)
      161. Dim binfmt As New BinaryFormatter()
      162. Return CType(binfmt.Deserialize(fs), Dictionary(Of String, Object))
      163. End Using
      164. End Function
      166. #Region "IApplicationSettingsProvider Members"
      167. ''' <summary>
      168. ''' Abrufen der letzten Version der Settingseigenschaft
      169. ''' </summary>
      170. ''' <param name="context"></param>
      171. ''' <param name="property"></param>
      172. Public Function GetPreviousVersion(ByVal context As SettingsContext, ByVal [property] As SettingsProperty) As SettingsPropertyValue Implements IApplicationSettingsProvider.GetPreviousVersion
      173. Dim prpValue As New SettingsPropertyValue([property])
      174. If Datas.ContainsKey([property].Name) Then prpValue.PropertyValue = Datas([property].Name)
      175. Return prpValue
      176. End Function
      178. ''' <summary>
      179. ''' wieder auf die Defaultwerte der Settings zurücksetzen!
      180. ''' </summary>
      181. ''' <param name="context"></param>
      182. Public Sub Reset(ByVal context As SettingsContext) Implements IApplicationSettingsProvider.Reset
      183. If DataFile.Exists Then Datas.Clear() : SaveBinary(DataFile, Datas)
      184. End Sub
      186. ''' <summary>
      187. ''' ErfinderDesRades
      188. ''' fehlende Settings werden sofort der Sammlung entfernt
      189. ''' neue hinzugekommene Settings werden beim nächsten Speichervorgang gesichert
      190. ''' </summary>
      191. ''' <param name="context"></param>
      192. ''' <param name="properties"></param>
      193. Public Sub Upgrade(ByVal context As SettingsContext, ByVal properties As SettingsPropertyCollection) Implements IApplicationSettingsProvider.Upgrade
      194. If Datas.Count = 0 AndAlso DataFile.Exists Then Datas = LoadBinary(DataFile)
      195. Dim toDelete = Datas.Keys.Except(properties.Cast(Of SettingsProperty).Select(Function(p) p.Name)).ToList
      196. toDelete.ForEach(AddressOf Datas.Remove)
      197. End Sub
      198. #End Region
      200. End Class
      201. End Namespace

      Die Schnittstelle IApplicationSettingsProvider (Versionierung) könnte man weglassen...
      Dann bleiben die Schnittstellen-Member (Upgrade, Reset und GetPreviousVersion) bei den Settings ohne Funktion.
      Dieser Provider wird einfach einem Projekt mitgegeben und ein Verweis angelegt.
      Bei der Version DirectorySettingsProvider kann man sogar den Persistierpfad außerhalb des Providers benutzerdefiniert angeben...

      Wichtig:
      Der Provider wird entweder, wie unten gezeigt, in der Settings.vb den Settings vorgelegt.
      Man geht auf die Seite Menü/Projekt/Projekt-Eigenschaften/Einstellungen. Beim Anwählen des Menüpunkts Code anzeigen
      wird im My-Namespace eine Partial Class des Designercodes erzeugt, in der man dann das Attribut für den UserSettingsProvider angeben kann (der Provider ist dann für alle Settings zuständig)...

      VB.NET-Quellcode

      1. Namespace My
      2. <Global.System.Configuration.SettingsProvider(GetType(UserSettingsProvider.MyProvider.UserSettingsProvider))> _
      3. Partial Friend NotInheritable Class MySettings
      4. End Class
      5. End Namespace

      Oder man gibt den einzelnen Settings bei der Eigenschaft Provider den vollständig qualifizierten Providernamen an!
      Dann werden nur die extra gekennzeichneten Settings benutzerdefiniert gespeichert - die anderen werden wie üblich persistiert...
      Man könnte auch verschiedene Provider, die dem Projekt verwiesen sind, der einzelnen Settings zuordnen.

      DemoSolution:
      Da werden die Eigenschaften Form.Location und die Form.ClientSize als Settings gebunden.
      Zum Weiteren sind noch einige Controls zur Veranschaulichung dargestellt.
      Der Pfad zur application.config.dat ist in diesem Projekt im Anwendungspfad festgelegt. Dieser kann individuell angepasst werden...
      Diesen Provider kann man sich als Vorlage nehmen und an seine Bedürfnisse anpassen...

      Danke an:
      @ErfinderDesRades : für seine Vorschläge und Einwände
      @RodFromGermany : Hinweis bei Benutzung mehrerer Anwendungen, die den gleichen Provider verwenden

      Anbei jetzt die letzte Version der korrigierten DemoSolution.
      Dateien

      Dieser Beitrag wurde bereits 27 mal editiert, zuletzt von „VB1963“ ()

      Danke für deinen Hinweis - ich habe die DemoSolution erneuert!
      Mir ist da leider eine falsche Solution hineingerutscht... :|
      Interessant war hier, wenn man die Benamung der Settings im SettingsEditor vornimmt,
      diese Änderungen im FormsDesigner richtig und im DesignerCode aber nicht übernommen werden! 8|
      Es wird dann erst in der Laufzeit gemeldet, dass hier die geänderte Eigenschaft nicht zu finden ist...
      Also man soll sich da niemals darauf verlassen...

      jetzt gucke ich grad die Upgrade-Sub an, und scheint mir suspekt:

      VB.NET-Quellcode

      1. ''' <summary> Dictionary Datas() wird mit PropertyCollection synchronisiert und aufgeräumt </summary>
      2. Public Sub Upgrade(ByVal context As SettingsContext, ByVal properties As SettingsPropertyCollection) Implements IApplicationSettingsProvider.Upgrade
      3. If Datas.Count = 0 AndAlso DataFile.Exists Then Datas = LoadBinary(DataFile)
      4. For i = Datas.Count - 1 To 0 Step -1
      5. Dim Key = Datas.Keys(i)
      6. Dim f = False
      7. For Each c As SettingsProperty In properties
      8. If c.Name <> Key Then Continue For
      9. f = True : Exit For
      10. Next
      11. If f Then Continue For
      12. Datas.Remove(Key)
      13. Next
      14. End Sub
      Also wenn in den properties Keys fehlen, werden die auch aus dem Dictionary gelöscht, aber wenn neue Properties hinzukamen - muss da nix geadded werden?

      Die alten gespeicherten Settings können keine neuen Eigenschaften enthalten.
      Das kann nur in der neuen Version passieren und die muss erst gespeichert werden.
      Ich gebe zu, dass diese Schleife patschert ausgeführt ist. Die muss ich unbedingt umschreiben...

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „VB1963“ ()

      Unten die neue Upgrade-Methode...

      VB.NET-Quellcode

      1. Public Sub Upgrade(ByVal context As SettingsContext, ByVal properties As SettingsPropertyCollection) Implements IApplicationSettingsProvider.Upgrade
      2. If Datas.Count = 0 AndAlso DataFile.Exists Then Datas = LoadBinary(DataFile)
      3. Dim tmp = (From e In properties Select DirectCast(e, SettingsProperty).Name).ToList
      4. For i = Datas.Count - 1 To 0 Step -1
      5. Dim Key = Datas.Keys(i)
      6. If Not tmp.Contains(Key) Then Datas.Remove(Key)
      7. Next
      8. End Sub

      Das geht noch besser

      VB.NET-Quellcode

      1. ''' <summary> entfernt in den Properties nicht mehr vorhandene Settings auch aus dem Datas-Dictionary </summary>
      2. Public Sub Upgrade(ByVal context As SettingsContext, ByVal properties As SettingsPropertyCollection) Implements IApplicationSettingsProvider.Upgrade
      3. If Datas.Count = 0 AndAlso DataFile.Exists Then Datas = LoadBinary(DataFile)
      4. Dim toDelete = Datas.Keys.Except(properties.Cast(Of SettingsProperty).Select(Function(p) p.Name)).ToList
      5. toDelete.ForEach(AddressOf Datas.Remove)
      6. End Sub
      Der Kommentar geht vlt. noch besser - aber immerhin sagt der, was da passiert.

      Und das hier ist mir auch suspekt:

      VB.NET-Quellcode

      1. ''' <summary> DataFile-Datei löschen und reload, d.h. es gelten wieder die Defaultwerte! </summary>
      2. Public Sub Reset(ByVal context As SettingsContext) Implements IApplicationSettingsProvider.Reset
      3. If DataFile.Exists Then DataFile.Delete() : Datas = LoadBinary(DataFile)
      4. End Sub
      Erst wird DataFile deleted, und dann soll davon geladen werden??

      Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von „ErfinderDesRades“ ()

      Au, da hast du recht - die Reset-Methode failt und ist so nicht zu gebrauchen, das habe ich leider nicht mehr getestet gehabt :S .
      Im Grunde genommen geht es hierbei nur darum, dass die gespeicherten Properties aus dem Datafile geleert sind, d. h.,
      dass das Datenfile leer sein soll oder gar gelöscht ist.
      Nach dem Reset werden die Settings neu initialisiert und versucht neu zu Laden.
      Aber weil keine Daten vorhanden sind, werden die Defaultwerte herangenommen.

      VB.NET-Quellcode

      1. ' Dictionary Datas() löschen und speichern, d.h. es gelten wieder die Defaultwerte bei den Properties!
      2. Public Sub Reset(ByVal context As SettingsContext) Implements IApplicationSettingsProvider.Reset
      3. If DataFile.Exists Then Datas.Clear() : SaveBinary(DataFile, Datas)
      4. End Sub

      Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von „VB1963“ ()

      @VB1963 Ich hab da ein Problem.

      VB.NET-Quellcode

      1. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      liefert den Pfad zur DLL, nicht aber den Pfad zur dazugehörigen Exe.
      Wenn 2 Exen in einem Verzeichnis darauf zugreifen, überschreiben sie sich gegenseitig die Settings.
      Nun wollt ich mir mit coredll.dll.GetModuleFileName() den gesuchten Namen holen, aber das knallt hier bei meinem sch..... W8:
      An exception of type 'System.DllNotFoundException' occurred

      ------
      Die Prozedur gibt es noch mal in der "Kernel32.dll".

      VB.NET-Quellcode

      1. <DllImport("kernel32.dll", SetLastError:=True)> <PreserveSig()> _
      2. Public Shared Function GetModuleFileName(<[In]()> ByVal hModule As IntPtr, <Out()> ByVal lpFilename As StringBuilder, <[In]()> <MarshalAs(UnmanagedType.U4)> ByVal nSize As Integer) As UInteger
      3. End Function

      VB.NET-Quellcode

      1. Sub New()
      2. Dim sb As New StringBuilder(1024)
      3. GetModuleFileName(IntPtr.Zero, sb, 1024)
      4. Dim exePath = sb.ToString
      5. Dim fi = New FileInfo(exePath)
      7. ApplicationName = IO.Path.GetFileNameWithoutExtension(exePath)
      8. ' in der Debug-Umgebung auf dieselben Settings zugreifen
      9. If ApplicationName.ToLower.EndsWith(".vshost") Then
      10. ApplicationName = IO.Path.GetFileNameWithoutExtension(ApplicationName)
      11. End If
      13. AppPath = fi.DirectoryName
      14. DataFile = New FileInfo(IO.Path.Combine(AppPath, String.Concat(ApplicationName, ".exe.config.dat")))
      15. Datas = New Dictionary(Of String, Object)()
      16. End Sub

      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von „RodFromGermany“ ()

      Bei Projekt/Eigenschaften/Anwendung/Assemblyinformationen...
      kannst du einfach bei der Produktangabe einen Produktnamen für die Anwendung angeben, der zu anderen Anwendungen, die den Provider verwenden,
      verschieden sein muss.
      Dann kann er die Namen der Anwendungen unterscheiden (der wird im Provider mit der Property ApplicationName() abgerufen...)
      Ich hoffe das hilft dir weiter...

      VB1963 schrieb:

      Dann kann er die Namen der Anwendungen unterscheiden
      Wie gesagt:
      Ein Pfad, mehrere Exen, eine UserSettingsProvider.dll
      Der Setter von ApplicationName() wird im Konstruktor falsch befüllt:

      VB1963 schrieb:

      VB.NET-Quellcode

      1. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      2. ApplicationName = fi.Name.Replace(fi.Extension, String.Empty)
      Sieh Dir den Output von GetExecutingAssembly an:

      VB.NET-Quellcode

      1. Console.WriteLine(Assembly.GetExecutingAssembly.Location)
      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      Ja, das stimmt schon, aber die Property überschreibt sich irgendwann nach der Initialisierung und dann
      müsste etwas später der Produktname deiner Anwendung abgerufen werden können (je nach dem welche Anwendung den Provider gerade benutzt)...
      Da meine ich die Zeile #39 oben im 1.Post im Spoiler...

      VB1963 schrieb:

      abgerufen werden können
      Da ist aber DataFile bereits initialisiert.
      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      Sorry, jetzt weis ich warum's so ist... :/
      Dieses Demo ist hier nur für eine .exe gedacht, und da habe ich mich bereits für 'UserSettingsProvider.exe.config.dat', das im Konstruktor zusammengebaut wurde, entschieden. Das sich der Provider für mehrere Anwendungen zugleich eignet - habe ich hier gar nicht behandelt X/
      Bei mehreren Anwendungen genügt es erst beim Persistieren die Property ApplicationName() ab zu rufen - dann sollte die momentan verantwortliche Anwendung ausgegeben werden...

      VB1963 schrieb:

      ab zu rufen - dann
      kommt der Name der DLL raus.
      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      Ich habe den Provider jetzt ein wenig umgebaut:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Imports System.Configuration
      2. Imports System.ComponentModel
      3. Imports System.Reflection
      4. Imports System.IO
      5. Imports System.Collections.Specialized
      6. Imports System.Runtime.Serialization.Formatters.Binary
      8. Namespace MyProvider
      9. ''' <summary>
      10. ''' Dieser Provider speichert die betroffenen Settings-Einstellungen in eine eigene .exe.config.xml-Datei.
      11. ''' Diese Datei liegt im Arbeitsverzeichnis der Anwendung.
      12. ''' HINWEISE:
      13. ''' Die ApplicationName-Property erstellt die ProduktName-Eigenschaft von der My.Application.Info.ProduktName
      14. ''' Hier sollte in den Projekteigenschaften/Anwendung/Assemblyinformationen die Eigenschaft ProduktName = AssemblyName gestellt sein!
      15. ''' </summary>
      16. ''' <remarks></remarks>
      17. Public Class UserSettingsProvider
      18. Inherits SettingsProvider
      19. Implements IApplicationSettingsProvider
      21. Private Datas As Dictionary(Of String, Object)
      22. Private Property DataFile As FileInfo
      23. Private Property AppPath As String
      25. Sub New()
      26. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      27. ApplicationName = fi.Name.Replace(fi.Extension, String.Empty)
      28. AppPath = fi.FullName.Replace(fi.Name, String.Empty)
      29. 'DataFile = New FileInfo(Path.Combine(AppPath, String.Concat(ApplicationName, ".exe.config.dat")))'weglassen
      30. Datas = New Dictionary(Of String, Object)()
      31. End Sub
      33. Public Overrides Sub Initialize(ByVal name As String, ByVal config As NameValueCollection)
      34. MyBase.Initialize(ApplicationName, config)
      35. End Sub
      37. Public Overrides Property ApplicationName() As String ' hier wird der Produktname von der Assembly angegeben
      39. Public Overrides ReadOnly Property Name As String
      40. Get
      41. Return "UserSettingsProvider"
      42. End Get
      43. End Property
      45. ''' <summary>
      46. ''' SetPropertyValues wird erst abgearbeitet, wenn ApplicationSettingsBase.Save durchgeführt wird.
      47. ''' ApplicationSettingsBase stellt sicher, dass für jeden einzelnen Provider nur seine markierten Werte herangenommen werden.
      48. ''' Egal, ob der Provider auf einer Einzel-Einstellung angesetzt ist oder ob klassenweit die Einstellung angegeben wurde.
      49. ''' Wenn Einstellungen nicht verändert wurden, müssen sie nicht gespeichert werden!
      50. ''' Anwendungsspezifische Einstellungen können nicht geändert werden und werden daher auch nicht gespeichert!
      51. ''' </summary>
      52. ''' <param name="context"></param>
      53. ''' <param name="collection"></param>
      54. Public Overrides Sub SetPropertyValues(ByVal context As SettingsContext, ByVal collection As SettingsPropertyValueCollection)
      55. For Each prpValue As SettingsPropertyValue In collection
      56. If Not prpValue.IsDirty OrElse (prpValue.SerializedValue Is Nothing) Then Continue For
      57. If IsApplicationScoped(prpValue.Property) Then Continue For
      58. Datas(prpValue.Name) = prpValue.SerializedValue
      59. Next
      60. SaveBinary(DataFile, Datas)
      61. End Sub
      63. Public Overrides Function GetPropertyValues(ByVal context As SettingsContext, ByVal collection As SettingsPropertyCollection) As SettingsPropertyValueCollection
      64. SetDataFile()
      65. If DataFile.Exists Then Datas = LoadBinary(DataFile)
      66. Dim col As New SettingsPropertyValueCollection()
      67. For Each prp As SettingsProperty In collection
      68. Dim Value As New SettingsPropertyValue(prp)
      69. If Datas.ContainsKey(prp.Name) Then Value = GetPropertyValue(prp) ' Wert von Datas einlesen
      70. col.Add(Value)
      71. Next
      72. Return col
      73. End Function
      75. ''' <summary>
      76. ''' Nur benutzerspezifische Eigenschaften sind zulässig.
      77. ''' Wenn eine Eigenschaft keinen Wert hat, wird der Defaultwert geladen.
      78. ''' </summary>
      79. ''' <param name="prp"></param>
      80. Private Function GetPropertyValue(ByVal prp As SettingsProperty) As SettingsPropertyValue
      81. Dim value As New SettingsPropertyValue(prp)
      82. If IsUserScoped(prp) Then value.SerializedValue = Datas(prp.Name)
      83. value.IsDirty = False
      84. Return value
      85. End Function
      87. ''' <summary>
      88. ''' Test auf anwendungsspezifische Eigenschaft
      89. ''' </summary>
      90. ''' <param name="prop"></param>
      91. Private Function IsApplicationScoped(ByVal prop As SettingsProperty) As Boolean
      92. Return HasSettingScope(prop, GetType(ApplicationScopedSettingAttribute))
      93. End Function
      95. ''' <summary>
      96. ''' Test auf benutzerdefinierte Eigenschaft
      97. ''' </summary>
      98. ''' <param name="prop"></param>
      99. Private Function IsUserScoped(prop As SettingsProperty) As Boolean
      100. Return HasSettingScope(prop, GetType(UserScopedSettingAttribute))
      101. End Function
      103. ''' <summary>
      104. ''' prüft auf erlaubte Einstellung, so wie es der LocalFileSettingsProvider auch macht ...
      105. ''' </summary>
      106. ''' <param name="prop"></param>
      107. ''' <param name="attributeType"></param>
      108. Private Function HasSettingScope(ByVal prop As SettingsProperty, ByVal attributeType As Type) As Boolean
      109. Dim isAppScoped As Boolean = prop.Attributes(GetType(ApplicationScopedSettingAttribute)) IsNot Nothing
      110. Dim isUserScoped As Boolean = prop.Attributes(GetType(UserScopedSettingAttribute)) IsNot Nothing
      111. If isUserScoped AndAlso isAppScoped Then Throw New ConfigurationErrorsException("BothScopeAttributes: " & prop.Name)
      112. If Not isUserScoped AndAlso Not isAppScoped Then Throw New ConfigurationErrorsException("NoScopeAttributes: " & prop.Name)
      113. Select Case True
      114. Case attributeType Is GetType(ApplicationScopedSettingAttribute) : Return isAppScoped
      115. Case attributeType Is GetType(UserScopedSettingAttribute) : Return isUserScoped
      116. Case Else : Return False
      117. End Select
      118. End Function
      120. ''' <summary>
      121. ''' Datenfile der gerade aktiven Anwendung bestimmen
      122. ''' </summary>
      123. ''' <remarks></remarks>
      124. Private Sub SetDataFile()
      125. Dim fi = New FileInfo(Assembly.GetExecutingAssembly.Location)
      126. AppPath = fi.FullName.Replace(fi.Name, String.Empty)
      127. DataFile = New FileInfo(Path.Combine(AppPath, String.Concat(ApplicationName, ".exe.config.dat")))
      128. End Sub
      130. ''' <summary>
      131. ''' Daten binär speichern
      132. ''' </summary>
      133. ''' <param name="DataFile"></param>
      134. ''' <param name="Datas"></param>
      135. Private Sub SaveBinary(DataFile As FileInfo, Datas As Dictionary(Of String, Object))
      136. SetDataFile()
      137. deleteLocalPathUserSettings()
      138. Using fs As Stream = File.Create(DataFile.FullName)
      139. Dim binfmt As New BinaryFormatter()
      140. binfmt.Serialize(fs, Datas)
      141. End Using
      142. End Sub
      143. ''' <summary>
      144. ''' falls der LocalUserAppDataPath vorhanden ist,
      145. ''' wird der Ordner mit allen untergeordneten Verzeichnissen gelöscht
      146. ''' </summary>
      147. ''' <remarks></remarks>
      148. Private Sub deleteLocalPathUserSettings()
      149. Dim di As New DirectoryInfo(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal).FilePath)
      150. di = di.Parent.Parent.Parent
      151. If di.Exists Then di.Delete(True)
      152. End Sub
      154. ''' <summary>
      155. ''' binäre Daten laden
      156. ''' </summary>
      157. ''' <param name="DataFile"></param>
      158. Private Function LoadBinary(DataFile As FileInfo) As Dictionary(Of String, Object)
      159. SetDataFile()
      160. Using fs As Stream = File.Open(DataFile.FullName, FileMode.Open)
      161. Dim binfmt As New BinaryFormatter()
      162. Return CType(binfmt.Deserialize(fs), Dictionary(Of String, Object))
      163. End Using
      164. End Function
      166. #Region "IApplicationSettingsProvider Members"
      167. ''' <summary>
      168. ''' Abrufen der letzten Version der Settingseigenschaft
      169. ''' </summary>
      170. ''' <param name="context"></param>
      171. ''' <param name="property"></param>
      172. Public Function GetPreviousVersion(ByVal context As SettingsContext, ByVal [property] As SettingsProperty) As SettingsPropertyValue Implements IApplicationSettingsProvider.GetPreviousVersion
      173. Dim prpValue As New SettingsPropertyValue([property])
      174. If Datas.ContainsKey([property].Name) Then prpValue.PropertyValue = Datas([property].Name)
      175. Return prpValue
      176. End Function
      178. ''' <summary>
      179. ''' wieder auf die Defaultwerte der Settings zurücksetzen!
      180. ''' </summary>
      181. ''' <param name="context"></param>
      182. Public Sub Reset(ByVal context As SettingsContext) Implements IApplicationSettingsProvider.Reset
      183. If DataFile.Exists Then Datas.Clear() : SaveBinary(DataFile, Datas)
      184. End Sub
      186. ''' <summary>
      187. ''' ErfinderDesRades
      188. ''' fehlende Settings werden sofort der Sammlung entfernt
      189. ''' neue hinzugekommene Settings werden beim nächsten Speichervorgang gesichert
      190. ''' </summary>
      191. ''' <param name="context"></param>
      192. ''' <param name="properties"></param>
      193. Public Sub Upgrade(ByVal context As SettingsContext, ByVal properties As SettingsPropertyCollection) Implements IApplicationSettingsProvider.Upgrade
      194. If Datas.Count = 0 AndAlso DataFile.Exists Then Datas = LoadBinary(DataFile)
      195. Dim toDelete = Datas.Keys.Except(properties.Cast(Of SettingsProperty).Select(Function(p) p.Name)).ToList
      196. toDelete.ForEach(AddressOf Datas.Remove)
      197. End Sub
      198. #End Region
      200. End Class
      201. End Namespace
      und um die SetDataFile-Methode erweitert (siehe Zeile#124)
      Das Festlegen der DataFile erfolgt immer erst vor einer Persistierung...
      Ich habe es mit 2 verschiedenen Anwendung getestet und es erzeugt 2 verschiedene DataFiles.
      Hier ist es wichtig, dass bei den Anwendungen der Produktname in den Assemblyinformationen verschieden angegeben ist!

      @VB1963 Wär doch gelacht, wenn wir das nicht hinkriegen.
      Was muss ich tun, um die Daten wie gewohnt als XML zu speichern / zu laden?
      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      VB1963 schrieb:

      SetDataFile
      In GetPropertyValues() muss auch ein SetDataFile() rein.
      Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
      Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
      Ein guter .NET-Snippetkonverter (der ist verfügbar).
      Programmierfragen über PN / Konversation werden ignoriert!

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „RodFromGermany“ ()

    Facebook
    Telefonspende