Control-Techniken: ActionListe und ControlDesigner hinzufügen und benutzen

    • VB.NET

      Control-Techniken: ActionListe und ControlDesigner hinzufügen und benutzen

      Zur Feier meines 1000. Beitrages dachte ich mir es wird mal wieder Zeit für ein Tutorial,
      und da diese Frage auch des öfteren gestellt wird, habe ich mir die Zeit genommen eine kleine Erklärung dazu zu verfassen.
      Natürlich werden für die erfolgreiche Ausführung diverse Grundkenntnisse benötigt.



      Was benötigen Sie?
      Für dieses Tutorial benötigen Sie keine besonderen Komponenten, lediglich ein Control,
      dass Sie mit einer Actionlist bzw. dem ControlDesigner erweitern wollen.

      Für dieses Tutorial verwende ich folgendes TestControl:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. <Designer(GetType(TestControlDesigner))>
      2. Public Class TestControl
      3. Inherits Control
      5. #Region "Declarations"
      6. ''' <summary>
      7. ''' Wird für die Angabe des Aktuellen Mausstatus benötigt.
      8. ''' </summary>
      9. ''' <remarks></remarks>
      10. Private CurrentState As MouseState = MouseState.None
      11. #End Region
      13. #Region "Enumerations"
      14. ''' <summary>
      15. ''' Enum für die Angabe des aktuellen Mausstatus.
      16. ''' </summary>
      17. ''' <remarks></remarks>
      18. Enum MouseState
      19. None = 0
      20. Over = 1
      21. Down = 2
      22. End Enum
      24. #End Region
      26. #Region "Sub-Area"
      27. Protected Overrides Sub OnMouseEnter(e As System.EventArgs)
      28. CurrentState = MouseState.Over
      29. Invalidate()
      30. MyBase.OnMouseEnter(e)
      31. End Sub
      33. Protected Overrides Sub OnMouseLeave(e As System.EventArgs)
      34. CurrentState = MouseState.None
      35. Invalidate()
      36. MyBase.OnMouseLeave(e)
      37. End Sub
      39. Protected Overrides Sub OnMouseDown(e As System.Windows.Forms.MouseEventArgs)
      40. CurrentState = MouseState.Down
      41. Invalidate()
      42. MyBase.OnMouseDown(e)
      43. End Sub
      45. Protected Overrides Sub OnMouseUp(e As System.Windows.Forms.MouseEventArgs)
      46. CurrentState = MouseState.Over
      47. Invalidate()
      48. MyBase.OnMouseUp(e)
      49. End Sub
      51. Protected Overrides Sub OnPaint(e As System.Windows.Forms.PaintEventArgs)
      52. Dim G As Graphics = e.Graphics
      54. Select Case CurrentState
      55. Case MouseState.None
      56. G.DrawRectangle(New Pen(Brushes.Green), New Rectangle(0, 0, Width - 1, Height - 1))
      57. Case MouseState.Over
      58. G.DrawRectangle(New Pen(Brushes.Yellow), New Rectangle(0, 0, Width - 1, Height - 1))
      59. Case MouseState.Down
      60. G.DrawRectangle(New Pen(Brushes.Red), New Rectangle(0, 0, Width - 1, Height - 1))
      61. End Select
      63. MyBase.OnPaint(e)
      64. End Sub
      65. #End Region
      67. #Region "Properties"
      68. Private _TestpropertyOne As Integer = 5
      69. ''' <summary>
      70. ''' Einfache Testeigenschaft zur veranschaulichung der Actionlist.
      71. ''' </summary>
      72. <Description("Einfache Testeigenschaft zur veranschaulichung der Actionlist.")>
      73. <Category("Testing")>
      74. <DefaultValue(5)>
      75. Public Property TestpropertyOne As Integer
      76. Get
      77. Return _TestpropertyOne
      78. End Get
      79. Set(value As Integer)
      80. _TestpropertyOne = value
      81. End Set
      82. End Property
      84. Private _TestpropertyTwo As Integer = 10
      85. ''' <summary>
      86. ''' Einfache Testeigenschaft zur veranschaulichung der Actionlist.
      87. ''' </summary>
      88. <Description("Einfache Testeigenschaft zur veranschaulichung der Actionlist.")>
      89. <Category("Testing")>
      90. <DefaultValue(10)>
      91. Public Property TestpropertyTwo As Integer
      92. Get
      93. Return _TestpropertyTwo
      94. End Get
      95. Set(value As Integer)
      96. _TestpropertyTwo = value
      97. End Set
      98. End Property
      99. #End Region
      101. End Class




      Was ist eine Actionlist?
      Als Actionlist bezeichnet man das Menü, dass sich beim Klicken auf das kleine Dreieck in der oberen rechten Ecke öffnet.
      Hier sieht man die Actionlist am Beispiel eines meiner Controls:



      Ebenfalls sieht man auf der Abbildung, dass man das Control nur nach links bzw. rechts vergrößern kann.
      Dies wurde mit Hilfe der Control-Designer-Klasse bewerkstelligt.




      Los geht's!
      Zusätzlich zu unser Control-Klasse erstellen wir uns jetzt eine zusätzliche Designer-Klasse.
      Der Name dieser Klasse ist grundsätzlich egal und kann variieren, jedoch ist es klug diesen mit dem Haupt-Control abzustimmen.
      Meine Klasse trägt den Namen: TestControlDesigner. Um diese Klasse nun zu einer ControlDesigner-Klasse zu machen, vererben wir ihr dies mit:
      Inherits System.Windows.Forms.Design.ControlDesigner.
      Als nächstes definieren wir uns noch eine Liste mit Private lists As DesignerActionListCollection

      Mit dem nächsten Schritt geben wir an, zu welchem Control der Designer gehört:

      VB.NET-Quellcode

      1. 'Gib an zu welchem Control der Designer gehört.
      2. Private ReadOnly Property HostControl() As MetroButton
      3. Get
      4. Return DirectCast(Me.Control, MetroButton)
      5. End Get
      6. End Property


      Nun fügen wir zu dem Designer die besagte Actionlist hinzu.
      Dies geschieht ebenfalls anhand einer simplen Eigenschaft:

      VB.NET-Quellcode

      1. 'Fügt die ActionListe zu dem Designer hinzu. (> Menü)
      2. Public Overrides ReadOnly Property ActionLists() As DesignerActionListCollection
      3. Get
      4. If lists Is Nothing Then
      5. lists = New DesignerActionListCollection()
      6. lists.Add(New MetroButtonActionList(Me.Component))
      7. End If
      8. Return lists
      9. End Get
      10. End Property


      Fürs erste wäre es das, da wir nun schon eine ActionList zu unserem Control hinzugefügt haben.
      Dennoch will ich ebenfalls noch ein paar zusätzliche Eigenschaften und Sub's, hinzufügen die ebenfalls sehr hilfreich sind.



      Zusätzliche Funktionen
      Zum Einen möchte ich nun erläutern, wie man dem Control die Richtungen vorgeben kann, in die es vergrößert bzw. verkleinert werden kann.
      Dazu fügen wir ebenfalls zu der ControlDesigner-Klasse eine neue Eigenschaft hinzu. Die Eigentschaft SelectionRules.

      VB.NET-Quellcode

      1. 'Bestimmt wie das Control vergrößert bzw. verkleinert werden kann.
      2. Public Overrides ReadOnly Property SelectionRules() As System.Windows.Forms.Design.SelectionRules
      3. Get
      4. Dim selRules As SelectionRules = Windows.Forms.Design.SelectionRules.Moveable
      5. selRules = selRules Or Windows.Forms.Design.SelectionRules.AllSizeable
      6. Return selRules
      7. End Get
      8. End Property


      Dies ist ein Beispiel, und setzt die SelectionRules auf AllSizable und somit gibt es keinen Unterschied.
      Folgende Enum-Werte kann man der SelectionRules Variabel zuweisen:


      Um z.B. kein verändern der Größe zu erlauben müssen Sie simpel den Wert der selRules Variabel auf folgendes ändern:
      selRules = selRules Or Windows.Forms.Design.SelectionRules.None

      Eine ebenfalls sehr hilfreiche Funktion des ControlDesigners ist, dass man einfach Eigenschaften entfernen kann.
      Dies wird mit folgendem Code bewerkstelligt:

      VB.NET-Quellcode

      1. 'Entfern Eigenschaft auf dem Control.
      2. Protected Overrides Sub PostFilterProperties(ByVal properties As System.Collections.IDictionary)
      3. properties.Remove("BorderStyle")
      4. properties.Remove("RightToLeft")
      5. properties.Remove("Text")
      6. properties.Remove("ForeColor")
      7. properties.Remove("Font")
      8. MyBase.PostFilterProperties(properties)
      9. End Sub




      Verwendung der ActionList
      Kommen wir nun zu dem Teil in dem ich Ihnen zeigen möchte, wie Sie ihr Control mit einer ActionList erweitern können.
      Dies geschieht ebenfalls über eine Klasse. Wie schon vorhin bei der Designerklasse können Sie diese ebenfalls beliebig benennen, jedoch empfehle ich Ihnen diese ebenfalls wie ich TestControlActionList zu nennen.
      Dieser Klasse vererben wir aus DesignerActionList mit Inherits DesignerActionList.
      Anschließend erstellen wir zwei Privates:

      VB.NET-Quellcode

      1. Private _ctrl As TestControl
      2. Private designerActionSvc As DesignerActionUIService = Nothing


      Der nächste Schritt is der, in dem der ActionList das TestControl zugewiesen wird. Dies geschieht in der Sub New

      VB.NET-Quellcode

      1. Public Sub New(ByVal component As IComponent)
      2. MyBase.New(component)
      3. _ctrl = DirectCast(component, TestControl)
      5. Me.designerActionSvc = CType(GetService(GetType(DesignerActionUIService)), DesignerActionUIService)
      6. End Sub


      Im Großen und Ganzen sind wir nun fast fertig, und Sie können gleich ihre ActionList verwenden. Jedoch müssen wir in der ActionList-Klasse nochmals die Eigenschaften deklarieren und erstellen, die unser HostControl besitzt und die in die ActionList eingebaut werden sollen. Diese wären in meinem Fall TestpropertyOne und TestpropertyTwo.
      Diese erstelle ich einfach genau gleich wie in der Hauptklasse des Controls:

      VB.NET-Quellcode

      1. Public Property TestpropertyOne() As Integer
      2. Get
      3. Return _ctrl.TestpropertyOne
      4. End Get
      5. Set(ByVal value As Integer)
      6. _ctrl.TestpropertyOne = value
      7. End Set
      8. End Property
      10. Public Property TestpropertyTwo() As Integer
      11. Get
      12. Return _ctrl.TestpropertyTwo
      13. End Get
      14. Set(ByVal value As Integer)
      15. _ctrl.TestpropertyTwo = value
      16. End Set
      17. End Property


      Ebenfalls möchte ich Ihnen nun zeigen, wie Sie eine Sub via der ActionList aufrufen können.
      Dazu erstellen wir einfach eine simple Sub. In meinem Fall vertauscht diese die Werte der beiden Eigenschaften mit einander.

      VB.NET-Quellcode

      1. Public Sub SwapValues()
      2. Dim i As Integer = _ctrl.TestpropertyOne
      3. _ctrl.TestpropertyOne = _ctrl.TestpropertyTwo
      4. _ctrl.TestpropertyTwo = i
      5. designerActionSvc.Refresh(_ctrl)
      6. End Sub


      Kommen wir nun zum Abschluss des Ganzen. Wir fügen die zwei Eigenschaften und die einzelne Sub zu der ActionList hinzu.
      Dazu erstellen wir eine Funktion die die GetSortedActionItems Funktion überschreibt:

      VB.NET-Quellcode

      1. Public Overrides Function GetSortedActionItems() As System.ComponentModel.Design.DesignerActionItemCollection
      2. Dim items As New DesignerActionItemCollection
      4. items.Add(New DesignerActionHeaderItem("Eigenschaften"))
      5. items.Add(New DesignerActionPropertyItem("TestpropertyOne", "TestpropertyOne:", "Eigenschaften", "Einfache Testeigenschaft zur veranschaulichung der Actionlist."))
      6. items.Add(New DesignerActionPropertyItem("TestpropertyTwo", "TestpropertyTwo:", "Eigenschaften", "Einfache Testeigenschaft zur veranschaulichung der Actionlist."))
      8. items.Add(New DesignerActionMethodItem(Me, "SwapValues", "Swap Values", "Eigenschaften", "Vertauscht die beiden Werte."))
      10. Return (items)
      11. End Function


      Diese Funktion sollte sich eigentlich von selbst erklären, dennoch möchte ich sie noch etwas erläutern:
      items.Add(New DesignerActionHeaderItem("Eigenschaften")) erstellt eine einfache Überschrift.

      items.Add(New DesignerActionPropertyItem("TestpropertyOne", "TestpropertyOne:", "Eigenschaften", "Einfache Testeigenschaft zur veranschaulichung der Actionlist.")) besteht aus folgenden Objekten

      Heißt, dem Namen der Property, dem Anzeigenamen, der Kategorie und einer einfachen Beschreibung.

      Das Hinzufügen der Sub funktioniert grundsätzlich genau gleich bis auf eine kleine Veränderung:

      Bevor man die Methode angibt, muss man noch die ActionList auswählen zu der die Methode gehört. Und dies ist in unserem Fall logischerweise Me.



      Das war's!
      Und schon wurde Ihr Control um eine ActionList und andere hilfreiche Funktionen erweitert.
      Ich hoffe sehr, dass ich Ihnen damit weiterhelfen konnte.

      Natürlich habe ich zum Schluss noch ein paar Downloads hinzugefügt, die Sie ebenfalls als Lernhilfe bzw. Veranschaulichungsmaterial verwenden können.

      Mit freundlichen Grüßen
      Martin Pfeiffer (Gather)
      Bilder

      • Screen3.PNG

        3,94 kB, 267×128, 1.023 mal angesehen
      Dateien
      Mfg: Gather
      Private Nachrichten bezüglich VB-Fragen werden Ignoriert!

    Facebook
    Telefonspende