Klassen. 3.1 Was Sie in diesem Kapitel erwartet. 3.2 Allgemeines

Transkript

1

2 3 Klassen 3.1 Was Sie in diesem Kapitel erwartet In diesem Kapitel erfahren Sie, was Klassen sind und warum man diese überhaupt einsetzen sollte. Es soll gleichzeitig etwas Werbung für das Konzept der Klassenprogrammierung betrieben werden. Ein Beispiel zeigt, wie man Steuerelemente dynamisch in eine Userform und ein Tabellenblatt einfügt und wie man mit den Ereignissen dieser Steuerelemente umgeht. Dazu sind Klassen nämlich unerlässlich. 3.2 Allgemeines Klassen bilden die Grundlage der objektorientierten Programmierung. Sie kapseln die Funktionalität von Objekten, machen den Code übersichtlicher und man kann den übergeordneten Programmablauf besser verstehen. Wenn Sie Codeteile besitzen, die Sie immer wieder benutzen, sollten Sie auf jeden Fall eine eigene Klasse dafür anlegen, auch wenn Ihnen das anfangs etwas umständlich vorkommt. Die Vorteile sind enorm und je häufiger Sie selbst Klassen schreiben und einsetzen, umso mehr werden Sie davon überzeugt sein. Der wohl größte Vorteil ist der, dass Sie mit einer Klasse ein kompaktes, wiederverwendbares Objekt mit Eigenschaften und Methoden besitzen und beim Einsatz dieser Klasse nicht mehr wissen müssen, wie die Funktionalität überhaupt implementiert wurde. Es reicht, wenn Sie deren Eigenschaften, Methoden und Funktionen kennen. Arbeiten Sie im Team, müssen Sie gemeinsam lediglich die öffentlichen Eigenschaften und Methoden der Klassen festlegen. Die anderen Programmierer können anschließend die von Ihnen geschriebenen Klassen benutzen, ohne dass sie sich mit dem Code auseinandersetzen müssen, der dahintersteht. Für 101

3 3 Klassen andere ist also Ihre Klasse eine Blackbox, vergleichbar mit einem Fernseher oder DVD-Player. Bei diesen Geräten muss man auch nicht unbedingt wissen, wie sie funktionieren, um sie benutzen zu können. Vielleicht stellt es sich irgendwann einmal heraus, dass sich in Ihre Klasse ein Fehler eingeschlichen hat. Dann brauchen Sie nicht in jeder Anwendung, die diese Klasse benutzt, den Code anzupassen. Sie tauschen in den betroffenen Arbeitsmappen lediglich die fehlerhafte Klasse gegen eine fehlerfreie aus. Auch Erweiterungen der Klasse sind ohne Weiteres möglich und beeinflussen die bestehenden Anwendungen nicht, wenn die vorhandenen Eigenschaften und Methoden beibehalten werden. Finden Sie später Möglichkeiten, bestimmte Eigenschaften und Methoden der Klasse effizienter zu gestalten, nur zu. Es hat keine negativen Auswirkungen auf die Anwendungen, die sich der Klasse bedienen. Sie können auch auf einfache Art einen Schreibschutz für bestimmte Eigenschaften verwirklichen, indem Sie die Prozeduren Property Let und Property Set ganz einfach weglassen. Sie können sogar mithilfe von Klassen benutzerdefinierte Typen nachbilden, die im Gegensatz zu den normalen Typen eine gewisse Eigenintelligenz besitzen. Denkbar wären dann beispielsweise Typen, die in verschiedenen Ländern mit unterschiedlichen Maßeinheiten eingesetzt werden können und notwendige Umrechnungen intern durchführen. Übrigens beruhen nahezu alle Objekte, die Sie in Excel benutzen, auf Klassen. Wenn Sie den Objektkatalog öffnen (Abbildung 3.1), werden Sie Hunderte verschiedener Objektklassen vorfinden. Abbildung 3.1 Klassen im Objektkatalog 102

4 Instanzierung 3.3 Instanzierung Klassen sind keine fertigen Objekte, sie sind quasi die Schablonen dazu. Erst durch die Instanzierung werden daraus reale Objekte, mit denen man auch etwas anfangen kann. Diese Schablone kann beliebig oft verwendet werden und jedes erzeugte Objekt ist dabei unabhängig von allen anderen und besitzt einen eigenen Satz von internen Variablen. Eine Instanz einer Klasse kann man auf zwei Wegen anlegen: 1. Verwenden der Dim-Anweisung zusammen mit New Dim myclass As New clstest 2. Mit der Dim-Anweisung eine Objektvariable anlegen, mit»set Objektvariable = New Klasse«ein Objekt erstellen und gleichzeitig der Objektvariablen zuweisen Dim myclass As clstest Set myclass = New clstest Der Unterschied zwischen beiden Varianten ist der Zeitpunkt, ab dem das Objekt tatsächlich existiert. Bei der ersten Variante wird das Objekt erst bei einem Zugriff auf eine Methode oder Eigenschaft angelegt. Bei der zweiten Methode wird das Objekt bereits bei der Set-Anweisung zum Leben erweckt. 3.4 Eigenschaften und Methoden Für jede Eigenschaft benötigen Sie bis zu drei Property-Prozeduren, eine öffentliche Variable oder eine Funktion bzw. Prozedur. Die Property-Prozeduren stellen also lediglich eine mögliche Schnittstelle zur Außenwelt der Klasse dar und werden beim Setzen und Lesen ausgeführt. Sie sind also nicht unbedingt mit öffentlichen Variablen vergleichbar. Beim Auslesen einer Eigenschaft wird die Get-, beim Setzen die Let- und beim Setzen von Objekten die Set-Prozedur ausgeführt. Wenn Sie für eine Eigenschaft den Schreibschutz benötigen, lassen Sie einfach die Property-Prozeduren Let Set weg. Für jede Eigenschaft, die über eine Property-Prozedur gesetzt und ausgelesen wird, benötigen Sie zudem noch eine klassenweit gültige Variable, welche die Werte aufnimmt und für die gesamte Lebensdauer der Klasseninstanz speichert. In der Ereignisprozedur Class_Initialize können Sie diese Variablen initialisieren, also mit Werten vorbelegen. Diese Ereignisprozedur wird beim Anlegen der Klasseninstanz ausgeführt. Achtung Tipp Sie sollten die Property-Prozeduren so anpassen, dass diese ausschließlich den Datentyp der internen Variablen aufnehmen und zurückgeben, defaultmäßig wird nämlich eine Property mit dem Datentyp Variant erzeugt. 103

5 3 Klassen Für Methoden können Sie öffentliche Prozeduren oder Funktionen verwenden. Was Sie letztendlich verwenden, bleibt Ihnen überlassen. Eine Funktion bietet sich beispielsweise dann an, wenn als Rückgabewert der Erfolg einer Aktion signalisiert werden soll. 3.5 Ereignisprozeduren mit WithEvents Eine weitere wichtige Eigenschaft von Klassen ist, dass sie Ereignisse auslösen und auch Ereignisse von Objekten, die mit WithEvents deklariert wurden, empfangen können. In Klassenmodulen von UserForms oder Tabellenblättern stehen Ihnen schon vordefinierte Ereignisprozeduren zur Verfügung. Wenn Sie dort Objekte einfügen, können Sie auch deren Ereignisse benutzen. Wollen Sie aber zum Beispiel Schaltflächen dynamisch in Userforms einfügen, das heißt während der Laufzeit und nicht während der Entwicklungszeit, haben Sie das Problem, dass Ereignisprozeduren nicht als Arrays ausgeführt werden können. Sie benötigen also für jedes Objekt eine eigene Ereignisprozedur. Mit WithEvents und einer Klasse können Sie das ohne programmgesteuertes Einfügen von Code realisieren. Das Konzept ist anfangs nicht einfach zu verstehen, wenn man es aber ein paar Mal durchgespielt hat, ist es gar nicht mehr so schwer Dynamische Kontrollkästchen im Tabellenblatt An folgendem Beispiel, das Schritt für Schritt aufgebaut wird, kann man sich die Vorgehensweise am besten verdeutlichen. Es sollen programmgesteuert Kontrollkästchen (Checkboxen) in ein Tabellenblatt eingefügt werden und die Klickereignisse empfangen und ausgewertet werden: 1. Sie legen fest, von welchem Objekttypen Sie ein Ereignis empfangen wollen. Wir nehmen an, dass es sich dabei um eine CheckBox von MSForms handeln soll. 2. Fügen Sie zu Ihrem Projekt eine Klasse hinzu, als Name dafür wird hier clssheetevent vergeben. 3. Im Deklarationsbereich dieser Klasse legen Sie eine öffentliche Objektvariable des gewünschten Objekttyps an, in diesem Fall MSForms.CheckBox und zwar mit dem Schlüsselwort WithEvents. Das Schlüsselwort WithEvents legt fest, dass dieses Objekt in dieser Klasse ein Ereignis (Event) empfangen kann. Public WithEvents objcheckbox As MSForms.CheckBox 4. Im Deklarationsbereich der Klasse legen Sie eine weitere Objektvariable an. In diesem von außen übergebenen Objekt soll später eine Prozedur aufgerufen werden. Private mobjowner As Object 104

6 Ereignisprozeduren mit WithEvents 5. Der Objektvariablen mobjowner muss man von außen ein Objekt zuweisen können, also legt man dafür eine Eigenschaftsprozedur (Property) an. Da es sich um ein Objekt handelt, muss man Property Set benutzen. Public Property Set Owner(ByVal vnewvalue As Object) Set mobjowner = vnewvalue End Property 6. Jetzt erstellen Sie in der Klasse die Ereignisprozedur des Objekts. Das Ereignis ist dabei durch einen Unterstrich vom Objekt getrennt. Die angelegte Prozedur wird in diesem Fall durch das Ändern der mit der Objektvariablen objcheckbox verbundenen CheckBox ausgeführt. In dieser Prozedur rufen Sie die Zielprozedur mycheckbox_klickevent des als mobjowner übergebenen Objekts auf und übergeben dabei noch den Status der Checkbox. Private Sub objcheckbox_change() ' Klickevent des Buttons On Error Resume Next ' Eine öffentliche Prozedur in der als Owner übergebenen ' Klasse ausführen mobjowner.mycheckbox_klickevent objcheckbox 7. Fügen Sie das Objekt, das ein Ereignis auslösen soll, in ein Tabellenblatt ein. 8. Legen Sie im Klassenmodul des Tabellenblatts eine öffentliche Prozedur an, die bei einem Ereignis aufgerufen werden soll. Public Sub mycheckbox_klickevent(strvalue As String) 9. In einer Prozedur erstellen Sie für jede Checkbox in dem Tabellenblatt eine neue Instanz der Klasse clscheckbox. Damit die Instanz nicht nach dem Beenden der Prozedur gelöscht wird, hat man vorher eine Collection auf Klassenebene deklariert, der man die Instanz als neues Element übergibt. Während der Lebensdauer der Collection, also bis die Codezeile Set mycol = New Collection oder Set mycol = Nothing ausgeführt wird, bleibt die hinzugefügte Klasseninstanz am Leben. Die Eigenschaft Owner der angelegten Klasse bekommt einen Verweis auf das eigene Tabellenblatt. Und hier der zusammenhängende Code der Klasse mit dem Namen clssheet- Event: ' Auf CD Beispiele\03_Klassen_VBA\ ' Dateiname 03_01_Events.xlsm ' Modul clssheetevent Listing 3.1 Code der Klasse clssheetevent 105

7 3 Klassen Listing 3.1 (Forts.) Code der Klasse clssheetevent 'Events von diesem Objekt können hier ausgeführt werden Public WithEvents objcheckbox As MSForms.CheckBox 'Objektvariable zur Aufnahme einer Referenz Private mobjowner As Object Private Sub objcheckbox_change() ' Changeevent der Checkbox On Error Resume Next ' Eine öffentliche Prozedur in der als Owner übergebenen ' Klasse ausführen mobjowner.mycheckbox_klickevent objcheckbox Public Property Set Owner(ByVal vnewvalue As Object) ' Besitzer übergibt eine Referenz auf das Objekt, ' damit dort eine Prozedur aufgerufen werden kann Set mobjowner = vnewvalue End Property In das Klassenmodul eines Tabellenblatts: Listing 3.2 Code des Klassenmoduls des Tabellenblatts Events ' Auf CD Beispiele\03_Klassen_VBA\ ' Dateiname 03_01_Events.xlsm ' Tabelle Durchlaufen von Auflistungen Option Explicit ' Collection, damit die Objekte am Leben bleiben Private mobjevents As Collection Private mobjcheck As clssheetevent Public Sub mycheckbox_klickevent(objcheck As Object) ' Diese öffentliche Prozedur wird von jeder geladenen ' Klasse clstestevents nach einem Klick aufgerufen ' Meldung ausgeben With objcheck MsgBox.Name & vbcrlf & _ "Wert = " & objcheck.value End With Public Sub MakeEvents() Dim x As OLEObject Set mobjevents = New Collection For Each x In Me.OLEObjects ' Alle Ole-Objekte durchlaufen If TypeName(x.Object) = "CheckBox" Then ' Es handelt es sich um eine Checkbox ' Neue Ereignisklasse anlegen 106

8 Ereignisprozeduren mit WithEvents Set mobjcheck = New clssheetevent ' Zu überwachendes Objekt übergeben Set mobjcheck.objcheckbox = x.object ' Tabellenblatt übergeben Set mobjcheck.owner = Me ' Zur Collection hinzufügen, damit Klassen ' am Leben bleiben mobjevents.add mobjcheck Listing 3.2 (Forts.) Code des Klassenmoduls des Tabellenblatts Events Next End If Private Sub cmdaddevents_click() MakeEvents Private Sub cmdremoveall_click() Dim x As OLEObject For Each x In Me.OLEObjects ' Alle Ole-Objekte durchlaufen Next If TypeName(x.Object) = "CheckBox" Then ' Checkboxen löschen x.delete End If Private Sub cmdaddcheck_click() ' Checkbox hinzufügen Me.OLEObjects.Add ClassType:="Forms.CheckBox.1", _ Top:=(Me.OLEObjects.Count - 4) * 30, Left:=200, _ Width:=100, Height:=30 Die Klick-Ereignisprozedur der Schaltfläche cmdaddevents dient dafür, für jedes auf dem Tabellenblatt vorhandene Kontrollkästchen eine eigene Klasseninstanz anzulegen. Dazu wird die Prozedur MakeEvents aufgerufen. Die Klick-Ereignisprozedur cmdremoveall_click löscht alle vorhandenen Kontrollkästchen auf dem Tabellenblatt. Die Klick-Ereignisprozedur der Schaltfläche cmdaddcheck fügt auf dem Tabellenblatt ein neues Kontrollkästchen hinzu Ereignisprozeduren in Userforms Nachfolgend ein Beispiel zum dynamischen Einfügen von Buttons in Userforms und zum Empfangen des Klickereignisses in einer Klasse. In der Klasse wiederum kann man ein Ereignis auslösen, welches dann in der Besitzerklasse ausgeführt wird. 107

9 3 Klassen Erst einmal der Code der Klasse clsbuttonevents: Listing 3.3 Code der Klasse clsbuttonevents ' Auf CD Beispiele\03_Klassen_VBA\ ' Dateiname 03_01_Events.xlsm ' Modul clsbuttonevents ' Events von diesem Objekt können hier ausgeführt werden Public WithEvents objcommandbutton As MSForms.CommandButton ' Dieses Event kann in anderen Klassen ausgelöst werden Public Event KlickEvent(strName As String) ' Objektvariable zur Aufnahme einer Referenz Private mobjowner As Object Private Sub objcommandbutton_click() ' Klickevent des Buttons On Error Resume Next ' Eine öffentliche Prozedur in der als Owner übergebenen ' Userform ausführen mobjowner.mybutton_klickevent objcommandbutton.name ' Event in der Besitzerklasse auslösen und ' Name übergeben RaiseEvent KlickEvent(objCommandButton.Name) Public Property Set Owner(ByVal vnewvalue As Object) ' Besitzer übergibt eine Referenz auf die Userform, 'damit dort eine Prozedur aufgerufen werden kann Set mobjowner = vnewvalue End Property Hier folgt der Code, der in das Klassenmodul einer Userform gehört. In diese Userform gehört noch ein Button mit dem Namen cmdcreatenew. Listing 3.4 Code der Userform ufeventbutton ' Auf CD Beispiele\03_Klassen_VBA\ ' Dateiname 03_01_Events.xlsm ' Userform ufeventbutton ' Anzahl der UserForms Private lngcontrolcount As Long ' Y Position der Userform Private lngypos As Long ' Der gemeinsame Namensteil der Buttons Private Const ButtonName = "cmduserdefined" ' Collection, damit die Objekte am Leben bleiben Public objevents As New Collection 108

10 Ereignisprozeduren mit WithEvents ' Objektvariable anlegen und festlegen, dass Ereignisse ' empfangen werden können Private WithEvents objbutton As clstestevents Listing 3.4 (Forts.) Code der Userform ufeventbutton Private Sub AddCommand() ' Anzahl der Buttons speichern lngcontrolcount = lngcontrolcount + 1 ' Mehr als vier Buttons wollen wir nicht If lngcontrolcount > 4 Then Exit Sub ' Neues Klassenobjekt anlegen Set objbutton = New clstestevents ' Referenz auf die Userform übergeben Set objbutton.owner = Me ' Button anlegen Set objbutton.objcommandbutton = _ Me.Controls.Add _ ("Forms.CommandButton.1", _ ButtonName & Format(lngControlCount, "000")) ' Position und Name festlegen With objbutton.objcommandbutton.top = lngypos.caption = "Testbutton " & lngcontrolcount End With lngypos = lngypos + 25 'Klassenobjekte im Speicher halten objevents.add objbutton Public Sub objbutton_klickevent(strobjektname As String) ' Nur das letzte Klassenobjekt feuert dieses ' Event, denn objbutton hält nur eine Referenz auf ' den letzten Button. Man bräuchte für jedes Objekt ' solch eine Ereignisprozedur, also auch mehrere ' Objektvariablen. Arrays sind nicht erlaubt. MsgBox strobjektname,, "Ereignisprozedur" Public Sub mybutton_klickevent(strobjektname As String) 'Diese öffentliche Prozedur wird von jeder geladenen 'Klasse clstestevents nach einem Klick aufgerufen Dim lngindex As Long 'Steuerelementindex extrahieren lngindex = CLng(Right(strObjektname, 3)) 109

11 3 Klassen Listing 3.4 (Forts.) Code der Userform ufeventbutton 'Meldung ausgeben MsgBox strobjektname & " "Öffentliche Prozedur" Nummer :" & lngindex,, _ Private Sub cmdcreatenew_click() AddCommand Abbildung 3.2 Userform ufeventbutton Die Funktionalität der Userform Bei einem Klick auf den Button cmdcreatenew wird die Prozedur AddCommand aufgerufen. Wenn bereits mehr als vier Buttons angelegt wurden, wird diese aber sofort wieder verlassen. Die auf Klassenebene angelegte Objektvariable objbutton nimmt anschließend mit Set und New eine neue Instanz der Klasse clsbuttonevents auf. Da diese mit dem Schlüsselwort WithEvents deklariert wurde, können Ereignisse des damit verbundenen Objekts empfangen werden. Anschließend kann man eine Objektreferenz der Userform an die soeben instanzierte Klasse übergeben. Damit wird erreicht, dass die Klasse eine öffentliche Prozedur der Userform aufrufen kann. Zum Einfügen eines Buttons wird die Add-Methode der Controls-Auflistung in der Userform benutzt. Gleichzeitig bekommt die Klasse über die als öffentlich deklarierte Variable objcommandbutton eine Objektreferenz auf den soeben hinzugefügten Button. In der Klasse clsbuttonevents ist diese Variable mit WithEvents deklariert worden, also kann dort das Objekt Ereignisse auslösen. Anschließend wird die Position des Buttons festgelegt, ich erhöhe aber jeweils nur die Y-Position. Würde man an dieser Stelle einfach so die Prozedur beenden, hätte man beim nächsten Einfügen eines Buttons ein Problem. Legt man nämlich mit Set und New eine neue Instanz der Klasse clstestevents an und weist sie der Objektvariablen objbutton zu, wird die ältere, mit der Objektvariablen verbundene Klasseninstanz aus dem Speicher gelöscht. 110

12 Ereignisprozeduren mit WithEvents Also benutzt man eine klassenweit gültige Collection und fügt die Objektvariable als Element hinzu. Dadurch wird erreicht, dass noch zusätzlich eine Referenz auf das Klassenobjekt angelegt wird, die so lange bestehen bleibt, bis sie aus der Collection entfernt wird oder die Objektvariable der Collection auf Nothing gesetzt wird. Wird die Objektvariable objbutton für eine neue Klasseninstanz benutzt, bleibt wegen der noch bestehenden Referenz auch die ältere Instanz im Speicher. Die Prozedur objbutton_klickevent ist eine Ereignisprozedur, die von dem mit der Objektvariablen objbutton verbundenen Objekt ausgelöst wird. Deshalb wurde auch bei der Deklaration das Schlüsselwort WithEvents benutzt. Die Prozedur mybutton_klickevent ist eine öffentliche Prozedur. Diese wird bei einem Klick auf einen Button von der damit verbundenen Klasse aufgerufen. clsbuttonevents Die Objektvariable objcommandbutton vom Typ MSForms.CommandButton ist mit dem Schlüsselwort WithEvents deklariert worden. Im Deklarationsteil dieser Klasse wird noch das Event KlickEvent angelegt, das man innerhalb der Klasse feuern kann. Feuern bedeutet, dass man in der Klasse, die eine Instanz auf diese Klasse hält, eine Ereignisprozedur auslösen kann. Dazu muss die Objektvariable, die eine Instanz auf die feuernde Klasse hält, also in der Userform die Variable objbutton, mit dem Schlüsselwort WithEvents deklariert sein. Benutzt man in der Userform als Prozedurnamen den Objektnamen, hängt einen Unterstrich und den Ereignisnamen daran, kann die feuernde Klasse diese Prozedur aufrufen und ihr sogar Parameter übergeben. Ausgelöst wird das durch die Anweisung RaiseEvent KlickEvent(objCommandButton.Name). Umgekehrt kann das mit der Objektvariablen objcommandbutton verbundene Objekt, in diesem Beispiel ein eingefügter Button, eine Ereignisprozedur in der verbundenen Klasse aufrufen. Dazu wird wieder der Objektname mit dem Ereignisnamen durch einen Unterstrich verbunden und als Prozedurname benutzt (objcommandbutton_click). In der Property-Prozedur Property Set Owner wird eine Referenz auf die Userform an die Klasse übergeben und in der Variablen mobjowner gespeichert. Damit ist es möglich, eine öffentliche Prozedur des aufrufenden Objekts ausführen zu lassen. Die Zeile mobjowner.mybutton_klickevent ruft dann die entsprechende Prozedur in der Userform auf. Durch diesen kleinen Kniff kann man in der Userform eine einzige Prozedur für alle Klickereignisse realisieren. Damit man noch unterscheiden kann, welcher Button gerade angeklickt wurde, übergibt man zusätzlich den Namen des Buttons. 111

13 3 Klassen 3.6 Fazit Klassen werden leider immer noch zu wenig eingesetzt. Das ist sehr schade, denn das Konzept der Klassen ist hervorragend und zukunftsweisend. Deshalb möchte ich den Leser an dieser Stelle noch einmal ausdrücklich dazu auffordern, dieses Konzept zu verinnerlichen. Haben Sie Funktionen oder Prozeduren geschrieben, die von Ihnen voraussichtlich in mehr als einem Projekt verwendet werden, sofort ab damit in eine Klasse! Mehrere ähnliche Funktionen, beispielsweise solche zum Umrechnen von Einheiten, sollten Sie umgehend in einer Klasse zusammenfassen. Damit schaffen Sie Ordnung und erleichtern sich das Wiederverwenden bereits programmierter Funktionalitäten. Geben Sie den angelegten Klassen noch sprechende Namen und exportieren Sie diese, erledigt sich sogar das mühselige Zusammensuchen von Codeteilen aus den unterschiedlichsten Arbeitsmappen. 112