SettingsBinder - Komfortables binden von Controls an Settings

    • VB.NET

      SettingsBinder - Komfortables binden von Controls an Settings

      Zum grunsätzlichen Verständis des Settings und Binding Konzepts, empfehle ich ein Tutorial vom @ErfinderDesRades:
      Settings richtig verwenden + an Settings binden

      Im Normalfall wird ja jedes einzelne Control im Designer gebunden, das ist mir zu mühselig. :whistling:
      Um das ganze Binding Gedöns in einem Rutsch abzuwickeln, habe ich mir folgende Klasse zusammen gebastelt.
      Einfach die SettingPropertys in volgendem Schema benennen, "ControlName_ControlValue" (z.B. TextBox1_Text) und
      dann SettingsBinder.BindToControls(Control()) (+7 Überladungen) ausführen. Ist ein Control nicht im Array vorhanden, wird eine Exeption geworfen.

      SettingsBinder

      VB.NET-Quellcode

      1. Imports System.Configuration
      3. Public Class SettingsBinder
      5. #Region "Overloads"
      7. ''' <summary>
      8. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      9. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      10. ''' </summary>
      11. ''' <param name="_controls"></param>
      12. ''' <param name="_dataSourceUpdateMode"></param>
      13. Public Shared Sub BindToControls(ByVal _controls As Control(),
      14. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      15. DataSourceUpdateMode.OnPropertyChanged)
      16. BindToControls(My.Settings.Properties, _controls, My.MySettings.Default, True, _dataSourceUpdateMode)
      17. End Sub
      19. ''' <summary>
      20. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      21. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      22. ''' </summary>
      23. ''' <param name="_settingsPropertys"></param>
      24. ''' <param name="_controls"></param>
      25. ''' <param name="_dataSourceUpdateMode"></param>
      26. Public Shared Sub BindToControls(ByVal _settingsPropertys As SettingsPropertyCollection,
      27. ByVal _controls As Control(),
      28. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      29. DataSourceUpdateMode.OnPropertyChanged)
      30. BindToControls(_settingsPropertys, _controls, My.MySettings.Default, True, _dataSourceUpdateMode)
      31. End Sub
      33. ''' <summary>
      34. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      35. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      36. ''' </summary>
      37. ''' <param name="_controls"></param>
      38. ''' <param name="_dataSource"></param>
      39. ''' <param name="_dataSourceUpdateMode"></param>
      40. Public Shared Sub BindToControls(ByVal _controls As Control(),
      41. ByVal _dataSource As Object,
      42. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      43. DataSourceUpdateMode.OnPropertyChanged)
      44. BindToControls(My.Settings.Properties, _controls, _dataSource, True, _dataSourceUpdateMode)
      45. End Sub
      47. ''' <summary>
      48. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      49. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      50. ''' </summary>
      51. ''' <param name="_settingsPropertys"></param>
      52. ''' <param name="_controls"></param>
      53. ''' <param name="_dataSource"></param>
      54. ''' <param name="_dataSourceUpdateMode"></param>
      55. Public Shared Sub BindToControls(ByVal _settingsPropertys As SettingsPropertyCollection,
      56. ByVal _controls As Control(),
      57. ByVal _dataSource As Object,
      58. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      59. DataSourceUpdateMode.OnPropertyChanged)
      60. BindToControls(_settingsPropertys, _controls, _dataSource, True, _dataSourceUpdateMode)
      61. End Sub
      63. ''' <summary>
      64. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      65. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      66. ''' </summary>
      67. ''' <param name="_controls"></param>
      68. ''' <param name="_formattingEnabled"></param>
      69. ''' <param name="_dataSourceUpdateMode"></param>
      70. Public Shared Sub BindToControls(ByVal _controls As Control(),
      71. ByVal _formattingEnabled As Boolean,
      72. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      73. DataSourceUpdateMode.OnPropertyChanged)
      74. BindToControls(My.Settings.Properties, _controls, My.MySettings.Default,
      75. _formattingEnabled, _dataSourceUpdateMode)
      76. End Sub
      78. ''' <summary>
      79. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      80. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      81. ''' </summary>
      82. ''' <param name="_settingsPropertys"></param>
      83. ''' <param name="_controls"></param>
      84. ''' <param name="_formattingEnabled"></param>
      85. ''' <param name="_dataSourceUpdateMode"></param>
      86. Public Shared Sub BindToControls(ByVal _settingsPropertys As SettingsPropertyCollection,
      87. ByVal _controls As Control(),
      88. ByVal _formattingEnabled As Boolean,
      89. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      90. DataSourceUpdateMode.OnPropertyChanged)
      91. BindToControls(_settingsPropertys, _controls, My.MySettings.Default,
      92. _formattingEnabled, _dataSourceUpdateMode)
      93. End Sub
      95. ''' <summary>
      96. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      97. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      98. ''' </summary>
      99. ''' <param name="_controls"></param>
      100. ''' <param name="_dataSource"></param>
      101. ''' <param name="_formattingEnabled"></param>
      102. ''' <param name="_dataSourceUpdateMode"></param>
      103. Public Shared Sub BindToControls(ByVal _controls As Control(),
      104. ByVal _dataSource As Object,
      105. ByVal _formattingEnabled As Boolean,
      106. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      107. DataSourceUpdateMode.OnPropertyChanged)
      108. BindToControls(My.Settings.Properties, _controls, _dataSource, _formattingEnabled, _dataSourceUpdateMode)
      109. End Sub
      111. #End Region
      113. ''' <summary>
      114. ''' Bind SettingsProperty to controls. Propertys must have the following format :
      115. ''' "Control.Name_Control.Property", for example "TextBox1_Text".
      116. ''' </summary>
      117. ''' <param name="_settingsPropertys"></param>
      118. ''' <param name="_controls"></param>
      119. ''' <param name="_dataSource"></param>
      120. ''' <param name="_formattingEnabled"></param>
      121. ''' <param name="_dataSourceUpdateMode"></param>
      122. Public Shared Sub BindToControls(ByVal _settingsPropertys As SettingsPropertyCollection,
      123. ByVal _controls As Control(),
      124. ByVal _dataSource As Object,
      125. ByVal _formattingEnabled As Boolean,
      126. ByVal Optional _dataSourceUpdateMode As DataSourceUpdateMode =
      127. DataSourceUpdateMode.OnPropertyChanged)
      128. Dim propertyNames As New List(Of KeyValuePair(Of String, String))
      129. For Each propertyName As String In GetSettingsPropertyNames(_settingsPropertys)
      130. Dim propertyNameSplitted As String() = propertyName.Split("_"c)
      131. If propertyNameSplitted.Length = 2 Then
      132. propertyNames.Add(
      133. New KeyValuePair(Of String, String)(propertyNameSplitted.First, propertyNameSplitted.Last))
      134. End If
      135. Next
      136. For Each settingsPropertysName As KeyValuePair(Of String, String) In propertyNames
      137. Dim fullSettingsPropertysName As String = $"{settingsPropertysName.Key}_{settingsPropertysName.Value}"
      138. If GetControlNames(_controls).Contains(settingsPropertysName.Key) Then
      139. GetControlByName(_controls, settingsPropertysName.Key).DataBindings.Add(
      140. New Binding(settingsPropertysName.Value,
      141. _dataSource,
      142. fullSettingsPropertysName,
      143. _formattingEnabled,
      144. _dataSourceUpdateMode))
      145. Else
      146. Throw New ControlBindToSettingPropertyException(
      147. $"Can't bind property '{fullSettingsPropertysName}', control '{settingsPropertysName.Key}' not found in '_controls'.")
      148. End If
      149. Next
      150. End Sub
      152. #Region "Private Methods"
      154. Private Shared Function GetControlByName(ByVal _controls As Control(), ByVal _name As String) As Control
      155. Dim controlNames As New List(Of String)
      156. For Each control As Control In _controls
      157. If control.Name = _name Then Return control
      158. Next
      159. Return Nothing
      160. End Function
      162. Private Shared Function GetControlNames(ByVal _controls As Control()) As List(Of String)
      163. Dim controlNames As New List(Of String)
      164. For Each control As Control In _controls
      165. controlNames.Add(control.Name)
      166. Next
      167. Return controlNames
      168. End Function
      170. Private Shared Function GetSettingsPropertyNames(ByVal _value As SettingsPropertyCollection) As List(Of String)
      171. Dim propertyNames As New List(Of String)
      172. For Each settingsProperty As SettingsProperty In _value
      173. propertyNames.Add(settingsProperty.Name)
      174. Next
      175. Return propertyNames
      176. End Function
      178. #End Region
      180. <Serializable>
      181. Private Class ControlBindToSettingPropertyException
      182. Inherits Exception
      183. Public Sub New(ByVal _message As String)
      184. MyBase.New(_message)
      185. End Sub
      186. End Class
      188. End Class

      Um das benötige ControlArray zu erhalten, hier noch eine kleine Helfer-Klasse.
      Helper - ControlMethods.GetControls

      VB.NET-Quellcode

      1. Namespace Helper
      3. Public Class ControlMethods
      5. #Region "Overloads"
      7. Public Shared Function GetControls(ByVal _parent As Control,
      8. ByVal Optional _blacklist As Control() = Nothing) As Control()
      9. Return GetControls(_parent, False, Nothing, _blacklist)
      10. End Function
      12. Public Shared Function GetControls(ByVal _parent As Control,
      13. ByVal _recursive As Boolean,
      14. ByVal Optional _blacklist As Control() = Nothing) As Control()
      15. Return GetControls(_parent, _recursive, Nothing, _blacklist)
      16. End Function
      18. Public Shared Function GetControls(ByVal _parent As Control,
      19. ByVal _types As Type(),
      20. ByVal Optional _blacklist As Control() = Nothing) As Control()
      21. Return GetControls(_parent, False, _types, _blacklist)
      22. End Function
      24. Public Shared Function GetControls(ByVal _parent As Control,
      25. ByVal _types As Type(),
      26. ByVal _recursive As Boolean,
      27. ByVal Optional _blacklist As Control() = Nothing) As Control()
      28. Return GetControls(_parent, _recursive, _types, _blacklist)
      29. End Function
      31. #End Region
      33. Public Shared Function GetControls(ByVal _parent As Control,
      34. ByVal _recursive As Boolean,
      35. ByVal _types As Type(),
      36. ByVal Optional _blacklist As Control() = Nothing) As Control()
      37. Dim controlList As New List(Of Control)
      38. For Each control As Control In _parent.Controls
      39. If _types Is Nothing OrElse _types.Contains(control.GetType) Then controlList.Add(control)
      40. If _recursive Then controlList =
      41. controlList.Concat(GetControls(control, _recursive, _types, _blacklist)).ToList
      42. Next
      43. If Not _blacklist Is Nothing Then controlList = controlList.Except(_blacklist).ToList
      44. Return controlList.ToArray
      45. End Function
      47. End Class
      49. End Namespace

    Facebook
    Telefonspende