Erstellen von speziellen Ereignissen in C#

Transkript

1 Erstellen von speziellen Ereignissen in C# Anhand eines Projekts, das demonstriert, wie spezielle Ereignisse ausgelöst werden und wie sie sich auf den verwendeten Code auswirken, zeigen wir Ihnen, wie spezielle Ereignisse erstellt werden. Von Harold Davis, Builder.com, 18. Dezember 2002 Anfänger in C# müssen als Erstes die Verwendung der Ereignisse erlernen. In Teil 1 dieser Reihe wurden die Grundlagen der C#-Ereignisse geschildert und dargestellt, wie die Registerkarte Events im Fenster Properties genutzt werden kann. Außerdem wurde der autogenerierte Code erläutert, der durch die Verwendung der Registerkarte Events entsteht. Schritte zur Erstellung spezieller Ereignisse Wir wollen hier das Beispiel eines Ereignisses betrachten, das ausgelöst wird, wenn eine an eine Methode übergebene lange ganze Zahl eine Primzahl ist. Die Methode wird in einem Klassenmodul gespeichert, obwohl sie auch in die Form-Klasse eingefügt werden könnte, da in.net ein Formular nur die Instanz einer Klasse ist. Wir benutzen das Formular, das wir im ersten Teil dieser Reihe erstellt haben, sowohl um die Methode für das Auslösen des Ereignisses aufzurufen als auch um zu reagieren, wenn das Ereignis ausgelöst wurde. Hier die für diesen Vorgang erforderlichen Schritte: 1. Fügen Sie ein Klassenmodul zu dem Projekt hinzu. 2. Fügen Sie zu dem Modul eine Methode hinzu, die überprüft, ob die an sie übergegebene Zahl eine Primzahl ist und gegebenenfalls ein Ereignis auslöst. 3. Erstellen Sie einen Delegat im Formular (die Empfängerklasse). 4. Weisen Sie den Delegaten dem Ereignis zu. 5. Fügen Sie das Ereignis-Handler-Framework zu der Form-Klasse hinzu. 6. Verwenden Sie den Operator +=, um die Instanz der Empfängerklasse (das Formular) zu benachrichtigen, dass der Ereignis-Handler in der Instanz der Empfängerklasse aufgerufen werden soll, wenn das Ereignis im Klassenmodul ausgelöst wird. 7. Fügen Sie dem Ereignis-Handler einen Code hinzu, der entsprechend auf das Ereignis reagiert. Betrachten wir nun diese Schritte im Einzelnen. Erstellen von speziellen Ereignissen in C# Hinzufügen einer Klasse und einer Methode Sie können zum Hinzufügen eines Klassenmoduls zu einem C#-Projekt verschiedene Methoden benutzen. Eine besteht darin, durch Auswahl der Option Add Class im Menü Project das Dialogfeld Add New Item zu öffnen. Stellen Sie sicher, dass in der Übersicht Templates die Option Class ausgewählt ist, wie in Abbildung A dargestellt, und klicken Sie auf Open.

2 Abbildung A: Auswahl der Schablone Class Abbildung vergrößern Die neue, bis auf einen Klassenkonstruktor noch leere Klasse sieht wie in Listing A dargestellt aus. Zum besseren Verständnis haben ich die autogenerierten Kommentare aus unserem Beispiel entfernt. Fügen Sie, wie in Listing B gezeigt, eine Methode zu dieser Klasse hinzu, die überprüft, ob die an sie übergebene Zahl eine Primzahl ist. Geben Sie dem Ereignis, das bei Feststellung einer Primzahl ausgelöst wird, den Namen OnPrime. Sie sehen hier, wie die IsPrime-Methode aussieht, wenn das Ereignis OnPrime ausgelöst wird. Beachten Sie, dass das Ereignis die Primzahl als einen Parameter übergibt, wie in Listing C gezeigt. Deklarieren des Delegaten Nun deklarieren Sie für das Ereignis OnPrime einen Delegaten in der Klasse. Diese Deklaration kann an einer beliebigen Stelle im Klassenmodul eingefügt werden. Beachten Sie, dass Sie nicht unbedingt einen Delegaten erstellen müssen, vor allem bei Ereignis-Methoden, deren Signatur dem integrierten System.EventHandler-Delegat entspricht. Es ist jedoch sinnvoll, für jedes spezielle Ereignis einen Delegaten zu deklarieren. In unserem Beispiel ist dies notwendig, da zu der Signatur ein Parameter (die gefundene Primzahl) hinzugefügt wird. Hier die Deklaration für den Delegaten: public delegate void OnPrimeEventHandler (object sender, System.EventArgs e, long num); Weisen Sie dann den Delegaten dem Ereignis zu: public Ereignis OnPrimeEventHandler OnPrime; Das Klassenmodul ist nun komplett. Allerdings führt es vor der Schaffung des Codes in der Empfängerklasse noch keine sinnvollen Vorgänge aus. Wenn Sie das Projekt ausführen, dürften jedoch keine Syntaxfehler mehr vorliegen. Listing D enthält den vollständigen Code für das Klassenmodul.

3 Der Ereignis-Handler Kehren wir nur zu der Empfängerklasse zurück, die zufällig eine Form-Klasse ist (was, wie bereits erwähnt, nicht unbedingt der Fall sein muss), um einen Ereignis-Handler hinzuzufügen. Dieser sieht wie folgt aus: private void Class1_OnPrime (object sender, System.EventArgs e, long thenum) Benachrichtigung an die auslösende Klasse Fügen Sie nun eine Benachrichtigung zu der Instanz des Klassenmoduls hinzu, so dass der im Ereignis-Handler befindliche Code verarbeitet wird, wenn das Ereignis ausgelöst wurde. Zuvor muss jedoch erst eine Instanz der Class1 in der Form-Klasse eingerichtet werden. Erstellen Sie anschließend eine Schaltfläche mit der Bezeichnung btndoprimething. Dann fügen Sie den im Klick-Ereignis der Schaltfläche auszuführenden Code ein und zeigen den Rest in einem mehrzeiligen Textfeld an. Listing E zeigt den Code für das Klick-Ereignis, der eine Instanz von Class1 erstellt und das Ereignis in der Klasse anweist, den Ereignis-Handler zu benachrichtigen, wenn das Ereignis ausgelöst wird. Hinzufügen von Code zum Ereignis-Handler Schließlich müssen Sie zu dem Klick-Ereignis der Schaltfläche einen Code hinzufügen, der ein spezielles Ereignis auslöst, sowie zu dem Formular-Ereignis-Handler einen Code, der auf das Ereignis reagiert. Listing F zeigt den zum Klick-Ereignis der Schaltfläche hinzugefügten Code, der die IsPrime- Methode für ganze Zahlen von 1 bis 100 aufruft. Abschließend müssen Sie zu dem Ereignis-Handler einen Code hinzufügen, der sicherstellt, dass Ihr Ereignis ausgelöst wird. Jede Primzahl, die das Ereignis auslöst, wird im Textfeld angezeigt, wie in Listing G zu sehen. Abbildung B zeigt das gewünschte Endergebnis.

4 Abbildung B: Das fertige Projekt zeigt eine Liste mit Primzahlen im Textfeld an. Ich habe das in diesem Artikel erörterte Projekt als Zip-Archiv zum Download bereitgestellt, falls Sie sich den gesamten Source-Code anschauen möchten. Zur Installation des Projekts müssen Sie es auf einem Rechner mit Visual Studio in ein Verzeichnis extrahieren. Doppelklicken Sie dann auf das Windows Explorer-Icon der.sln-datei. Gute Ausgangsbasis Ereignisse sind ein zentrales Feature Objekt-orientierter Sprachen wie C#, und sie spielen bei der Konzeption von Projekten eine wichtige Rolle. Da bei der Programmierung von Ereignissen nur wenige Punkte zu beachten sind, dürften Sie nicht allzu viele Probleme mit der Nutzung dieser Schlüsselfunktion bekommen - immer vorausgesetzt, dass Sie die Konzepte, Kontexte und Reihenfolge aller Komponenten nicht durcheinander bringen. Listing A using System; namespace Builder2 public class Class1 public Class1()

5 Listing B using System; namespace Builder2 public class Class1 public Class1() public void IsPrime (long NumToCheck ) for (long i =2; i <= Math.Sqrt(NumToCheck); i++) if (NumToCheck%i == 0 ) // not a prime // is a prime, fire the event Listing C public void IsPrime (long NumToCheck ) for (long i =2; i <= Math.Sqrt(NumToCheck); i++) if (NumToCheck%i == 0 ) // not a prime // is a prime, fire the event System.EventArgs p = new System.EventArgs(); OnPrime (this, p, NumToCheck);

6 Listing D using System; namespace Builder2 public class Class1 public Class1() public delegate void OnPrimeEventHandler (object sender, System.EventArgs e, long num); public event OnPrimeEventHandler OnPrime; public void IsPrime (long NumToCheck ) for (long i =2; i <= Math.Sqrt(NumToCheck); i++) if (NumToCheck%i == 0 ) // not a prime // is a prime, fire the event System.EventArgs p = new System.EventArgs(); OnPrime (this, p, NumToCheck); Listing E private void btndoprimething_click(object sender, System.EventArgs e) Class1 class1 = new Class1(); class1.onprime += new Class1.OnPrimeEventHandler (this.class1_onprime); Listing F private void btndoprimething_click(object sender, System.EventArgs e) Class1 class1 = new Class1(); class1.onprime += new Class1.OnPrimeEventHandler (this.class1_onprime); for (long i=1; i <= 100; i++) class1.isprime (i); Listing G private void Class1_OnPrime (object sender, System.EventArgs e, long thenum) textbox1.text += thenum.tostring() + " is a prime\r\n";