Jürgen Bayer. MDI-Anwendungen in C#

Transkript

1 Jürgen Bayer MDI-Anwendungen in C#

2 Inhaltsverzeichnis 1 Grundlagen Einrichten der Formulare Öffnen von MDI-Childformularen 3 2 Menüs Erstellen eines Menüs Programmierung der Menüpunkte für das Beispiel Ein Fenster-Menüpunkt 10 3 Zugriff auf die Childs und den Parent Zugriff auf MDI-Childs vom MDI-Parent aus Zugriff auf dem MDI-Parent von MDI-Childs aus 12

3 MDI-Anwendungen starten mit einem Formular, dessen Eigenschaft IsMdiContainer auf true eingestellt ist. Diese Formulare werden dann als MDI-Parent bezeichnet. Wenn Sie ausgehend von einem solchen Formular andere Formulare öffnen, können Sie das Startformular nun über die Eigenschaft MDIParent als MDI-Parent des anderen Formulars angeben. Das andere Formular wird dann zum MDI-Child. MDI-Child- Formulare werden immer innerhalb des MDI-Parent angezeigt. Zusätzliche Features, wie das einfache Einrichten eines Fenster-Menüpunkts, der automatisch alle geöffneten MDI-Childs auflistet, das halbautomatische Ausrichten der MDI-Childs über die Methode LayoutMDI, und die Tatsache, dass das Menü eines MDI-Childs in das Menü des MDI-Parent eingeblendet wird, wenn das MDI-Child-Formular aktiv ist, erleichtern die Programmierung solcher Anwendungen. Microsoft Word ist übrigens ein gutes Beispiel für eine MDI-Anwendung: Das Hauptfenster von Word ist der MDI-Parent, die geöffneten Dokumente sind MDI- Childs. Für eine MDI-Anwendung benötigen Sie zunächst ein Startformular, dessen Eigenschaft IsMdiContainer auf true eingestellt ist. Das Formular sollte mit einem Menü ausgerüstet werden. Abbildung 1.1: Ein MDI-Parent-Formular mit Menü Ich entwickle in diesem Artikel eine einfache Textverarbeitung. Das MDI-Parentformular sollte dazu mit den Menüpunkten entsprechend Abbildung ausgerüstet werden. Die Menüpunkte Speichern und Schließen werden später Teil des MDI-Child-Formulars. MDI-Child-Formulare sind normale Formulare, die auch ein Menü besitzen können. Das Beispiel verwendet ein Formular mit einem RichTextBox-Steuerelement, in dem der Anwender einen RTF-Text bearbeiten kann. Grundlagen 2

4 Abbildung 1.2: Ein Formular mit RichTextBox und Menü als Basis für ein MDI-Child-Formular Das Format-Menü des Child-Formulars enthält im Beispiel die Menüpunkte Automatischer Zeilenumbruch und Schriftart. Bevor ich die Programmierung der Menüpunkte und des Konstruktors des Child-Formulars beschreibe, zeige ich, wie Sie dieses grundsätzlich öffnen und wie Sie das Menü so einstellen, dass dieses korrekt in das Menü des Parent-Formulars eingeblendet wird. Öffnen können Sie ein MDI-Child-Formular wie ein normales Formular. Vor dem Öffnen setzen Sie die Eigenschaft MDIParent des Formulars allerdings auf das MDI-Parent-Formular: private void mnufilenew_click(object sender, // Neues Editierformular erzeugen EditForm frmedit = new EditForm(); // und unmodal als MDI-Child anzeigen frmedit.mdiparent = this; frmedit.show(); Grundlagen 3

5 Das Menü des Child-Formulars wird abhängig von den Eingeschaften MergeType und MergeOrder der einzelnen Menüeinträge in das Menü des Parent-Formulars eingeblendet. Für MergeType sind die in Tabelle 1 dargestellten Einstellungen möglich. Beachten Sie, dass Sie die Einstellung für die korrespondierenden Menüpunkte im Child- und im Parent-Formular vornehmen müssen. Wert Add Replace MergeItems Remove Bedeutung Diese Einstellung gilt für einzelne Menüpunkte und bewirkt, dass der Menüpunkt dem Menü des MDI-Parentformulars hinzugefügt wird, auch wenn es bereits einen Menüpunkt mit derselben Beschriftung auf derselben Menüebene gibt. Bei gleich beschrifteten Menüpunkten auf einer Ebene existieren dann zwei Einträge. Diese Einstellung gilt ebenfalls für einzelne Menüpunkte und bewirkt, dass der Menüpunkt des Childformulars einen vorhandenen gleich beschrifteten Menüpunkt des Parentformulars auf derselben Ebene ersetzt. Diese Einstellung gilt für die Untermenüpunkte eines Menüpunkts und bewirkt, dass das Menü des Childformulars mit einem gleichnamigen Menü des Parentformulars zu einem einzelnen Menüpunkt zusammengefasst wird. Die Art der Zusammenfassung hängt von der Einstellung der untergeordneten Menüpunkte ab (Add, Replace oder Remove). Diese Einstellung gilt wieder für einzelne Menüpunkte und bewirkt, dass der Menüpunkt entfernt wird, wenn zwei Menüs kombiniert werden. Sinnvoll ist diese Einstellung für Menüpunkte des Parentformulars, die nicht sichtbar sein sollen, wenn ein Childformular geöffnet ist. Tabelle 1: Die Einstellungen der MergeType-Eigenschaft für Menüpunkte Wenn die Untermenüpunkte zweier Menüs kombiniert werden, hängt die Position der Menüpunkte von der Eigenschaft MergeOrder ab. Menüs 4

6 Die Menüpunkte des Datei-Menüs des Textverarbeitungs-Beispiels sind folgendermaßen eingestellt, damit dieses Menü korrekt kombiniert wird: Formular Menüpunkt MergeType MergeOrder Parent &Datei MergeItems 0 Parent &Neu Add 0 Parent &Öffnen Add 1 Parent - Add 5 Parent &Beenden Add 6 Child &Datei MergeItems 0 Child - Add 2 Child &Speichern Add 3 Child S&chließen Add 4 Tabelle 2: Einstellungen der MergeType- und MergeOrder-Eigenschaft der Beispielanwendung Abbildung 2.1 zeigt das MDI-Parentformular ohne geöffnetes Childformular, in Abbildung 2.2 ist ein Childformular geöffnet (und damit das Datei-Menü des MDI-Parent mit dem Datei-Menü des MDI-Child kombiniert). Abbildung 2.1: Das MDI-Parentformular der Beispielanwendung ohne geöffnetes Childformular Menüs 5

7 Abbildung 2.2: Das MDI-Parentformular der Beispielanwendung mit geöffnetem Childformular Die Menüpunkte, die zum Childformular gehören, beziehen sich immer auf das gerade aktive Childformular. Die Programmierung der Menüpunkte ist damit sehr einfach.!"#! Der Neu-Menüpunkt des MDI-Parentformulars erzeugt ein neues MDI-Childformular. Der Öffnen-Menüpunkt erzeugt ein neues MDI-Childformular, öffnet einen Datei-Öffnen-Dialog und öffnet die vom Anwender ausgewählte Datei im RichTextBox-Steuerelement des MDI-Childformulars. Das Öffnen der Datei geschieht im Konstuktor des Childformulars, weswegen dieser ein Argument erhält, das definiert, ob ein neues Dokument erzeugt oder ein vorhandenes geöffnet werden soll. Zur Verwaltung der Dokumenteninformationen enthält die Klasse drei Eigenschaften: // Eigenschaften zur Verwaltung des Dokuments private string filename = null; public string FileName get return filename; private static int counter = 0; // Eigenschaft, die die Modified-Eigenschaft // des RichTextBox-Steuerelements veröffentlicht public bool Modified get return rtbdocument.modified; Der Konstruktor sieht so aus: public EditForm(bool openexisting) InitializeComponent(); if (openexisting) // Vorhandenes Dokument öffnen. // Die eventuelle Ausnahme, die beim // Öffnen erzeugt wird, wird einfach // an den Aufrufer weitergegeben ofdrtffile.initialdirectory = Application.StartupPath; if (ofdrtffile.showdialog() == DialogResult.OK) // Datei laden Menüs 6

8 rtbdocument.loadfile(ofdrtffile.filename, RichTextBoxStreamType.RichText); // Dokument als nicht modifiziert kennzeichnen rtbdocument.modified = false; // Dateiname merken this.filename = ofdrtffile.filename; // Beschriftung setzen System.IO.FileInfo fi = new System.IO.FileInfo(this.fileName); this.text = fi.name; else // Ausnahme werfen throw new CancelException(); else // Neues Dokument counter++; this.text = "Dokument " + counter; Das Argument openexisting steuert, ob eine vorhandene Datei geöffnet werden soll. Soll ein vorhandenes Dokument geöffnet werden (openexisting == true), öffnet das Programm einen Datei-Öffnen-Dialog (ofdrtffile). Wenn der Anwender eine Datei ausgewählt hat, wird diese geöffnet. Ausnahmen, die dabei eventuell erzeugt werden, werden einfach an den Aufrufer weitergegeben. Betätigt der Anwender den Abbrechen-Schalter im Datei-Öffnen-Dialog, erzeugt das Programm einfach eine neue Ausnahme, deren Klasse in der Datei folgendermaßen implementiert ist: public class CancelException: Exception Im Konstruktor wird die Eigenschaft Modified des RichTextBox-Steuerelements auf false gesetzt. Über diese Eigenschaft ermittelt das Programm beim Schließen des Formulars, ob der Text im Steuerelement geändert wurde. Im MDI-Parent-Formular sieht der Quellcode des Neu- und des Öffnen-Menüpunkts folgendermaßen aus: private void mnufilenew_click(object sender, // Neues Editierformular erzeugen EditForm frmedit = new EditForm(false); // und unmodal als MDI-Child anzeigen frmedit.mdiparent = this; frmedit.show(); private void mnufileopen_click(object sender, // Neues Editierformular erzeugen bool ok = false; EditForm frmedit = null; try // Der Konstruktor ruft den Datei-Öffnen-Dialog // auf und erzeugt eine Ausnahme, wenn die Datei // nicht geöffnet werden kann oder wenn der // Anwender den Abbrechen-Schalter betätigt frmedit = new EditForm(true); ok = true; Menüs 7

9 catch (CancelException) // Nichts machen catch (Exception ex) MessageBox.Show(ex.Message, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error); if (ok) // Wenn alles OK ist, Form unmodal // als MDI-Child anzeigen frmedit.mdiparent = this; frmedit.show(); Der Speichern-Menüpunkt des MDI-Childformulars ruft die Methode SsaveFile auf: private void mnufilesave_click(object sender, // Dokument speichern this.savefile(); // Methode zum Speichern private bool savefile() // Dateiname ermitteln if (filename == null) // Datei-Speichern-Dialog öffnen sfdrtffile.initialdirectory = Application.StartupPath; if (sfdrtffile.showdialog() == DialogResult.OK) filename = sfdrtffile.filename; // Datei speichern if (filename!= null) try // Datei speichern rtbdocument.savefile(filename, RichTextBoxStreamType.RichText); // Dokument als nicht modifiziert kennzeichnen rtbdocument.modified = false; // Beschriftung setzen System.IO.FileInfo fi = new System.IO.FileInfo(this.fileName); this.text = fi.name; return true; catch (Exception ex) MessageBox.Show(ex.Message, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error); return false; Menüs 8

10 else return false; Der Schließen-Menüpunkt schließt das Formular (was auch sonst...): private void mnufileclose_click(object sender, // Dokument schließen (die Abfrage, ob gespeichert // werden soll, erfolgt im Closing-Ereignis) this.close(); Im Closing-Ereignis des Formulars fragt das Programm ab, ob das Dokument geändert wurde und ruft gegebenenfalls die Save-Methode auf: private void EditForm_Closing(object sender, System.ComponentModel.CancelEventArgs e) // Überprüfen, ob das Dokument geändert wurde if (rtbdocument.modified) // Abfragen, ob gespeichert werden soll switch (MessageBox.Show("Möchten Sie Ihre " + "Änderungen an '" + this.text + "' speichern?", Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question)) case DialogResult.Yes: if (this.savefile() == false) // Wenn nicht gespeichert werden kann, // wird das Schließen abgebrochen e.cancel = true; break; case DialogResult.Cancel: // Abbrechen e.cancel = true; break; Nun fehlen zunächst noch die Ereignisbehandlungsmethoden für die Menüpunkte des Format-Menüs. Die Methode für die Schriftart nutzt einen Schriftauswahldialog (fdrtffont): private void mnuformatfont_click(object sender, // Schriftart der aktuellen Selektion definieren if (fdrtffont.showdialog() == DialogResult.OK) rtbdocument.selectionfont = fdrtffont.font; rtbdocument.selectioncolor = fdrtffont.color; Menüs 9

11 Die Methode für den automatischen Zeilenumbruch schaltet die Eigenschaft WordWrap des RichTextBox- Steuerelements um: private void mnuformatwordwrap_click(object sender, // WordWrap umschalten mnuformatwordwrap.checked =!mnuformatwordwrap.checked; rtbdocument.wordwrap = mnuformatwordwrap.checked; $!" Das MDI-Parent-Formular besitzt normalerweise ein Menü Fenster, über den Sie die einzelnen geöffneten Dokumente erreichen und ausrichten können. Eine Liste der geöffneten Dokumente erhalten Sie automatisch, wenn Sie die Eigenschaft MdiList dieses Menüs auf true setzen. Für die üblichen Menüpunkte zum Ausrichten der Fenster nutzen Sie die LayoutMdi-Methode: private void mnuwindowcascade_click(object sender, // Fenster kaskadierend anordnen this.layoutmdi(mdilayout.cascade); private void mnuwindowtilevertical_click(object sender, // Fenster vertikal geteilt anordnen this.layoutmdi(mdilayout.tilevertical); private void mnuwindowtilehorizontal_click(object sender, // Fenster horizontal geteilt anordnen this.layoutmdi(mdilayout.tilehorizontal); private void mnuwindowarrangeicons_click(object sender, // Fenstersymbole anordnen this.layoutmdi(mdilayout.arrangeicons); Menüs 10

12 $ % $ % Wenn Sie vom MDI-Parent aus auf MDI-Childs zugreifen wollen, können Sie die Eigenschaft ActiveMdiChild verwenden, die eine Referenz auf das gerade aktive MDI-Childformular darstellt. Im Ereignis MdiChildActivate können Sie darauf reagieren, dass ein MDI-Childformular aktiviert wurde. Das folgende Beispiel schreibt den Dateinamen des aktiven Dokuments und eine Information darüber, ob das Dokument ungespeicherte Änderungen enthält, in ein StatusBar-Steuerelement auf dem MDI-Parent-Formular: // Methode zum Setzen des Textes der StatusBar public void SetStaturBarText() if (ActiveMdiChild!= null) sbr.text = ((EditForm)ActiveMdiChild).FileName; if (((EditForm)ActiveMdiChild).Modified) sbr.text += " (geändert)"; else sbr.text = ""; private void StartForm_MdiChildActivate(object sender, // Wenn ein MDI-Child-Formular aktiviert wird: // Den Dateinamen des Dokuments und eine Information // darüber, ob die letzten Änderungen am Text noch // nicht gespeichert sind, in der StatusBar ausgeben this.setstaturbartext(); Zugriff auf die Childs und den Parent 11

13 $ % Ein MDI-Childformular kann über seine Eigenschaft MdiParent auch auf das MDI-Parentformular zugreifen. Das folgende Beispiel erweitert die Speichern-Methode so, dass beim Speichern die SetStaturBarText- Methode des MDI-Parent aufgerufen wird: bool savefile() // Dateiname ermitteln if (filename == null) // Datei-Speichern-Dialog öffnen sfdrtffile.initialdirectory = Application.StartupPath; if (sfdrtffile.showdialog() == DialogResult.OK) filename = sfdrtffile.filename; // Datei speichern if (filename!= null) try // Datei speichern rtbdocument.savefile(filename, RichTextBoxStreamType.RichText); // Dokument als nicht modifiziert kennzeichnen rtbdocument.modified = false; // Beschriftung setzen System.IO.FileInfo fi = new System.IO.FileInfo(this.fileName); this.text = fi.name; // StatusBar-Text des MDI-Parent neu definieren ((StartForm)this.MdiParent).SetStaturBarText(); return true; catch (Exception ex) MessageBox.Show(ex.Message, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error); return false; else return false; Zugriff auf die Childs und den Parent 12