Exemplarische Vorgehensweise: Erben von einem Windows Forms-Steuerelement mit C#

Artikel
05/04/2023

Mit C# können Sie leistungsstarke benutzerdefinierte Steuerelemente durch Vererbung erstellen. Durch Vererbung können Sie Steuerelemente erstellen, die die gesamte Funktionalität der standardmäßigen Windows Forms-Steuerelemente, aber auch benutzerdefinierte Funktionen enthalten. In dieser exemplarischen Vorgehensweise erstellen Sie ein einfaches geerbtes Steuerelement mit dem Namen ValueButton. Diese Schaltfläche erbt die Funktionalität des standardmäßigen Button-Steuerelements von Windows Forms und stellt eine benutzerdefinierte Eigenschaft namens ButtonValue bereit.

Erstellen des Projekts

Geben Sie beim Erstellen des Projekts den Namen an, um den Stammnamespace, Assemblynamen und Projektnamen festzulegen und sicherzustellen, dass sich die Standardkomponente im richtigen Namespace befindet.

So erstellen Sie die „ValueButtonLib“-Steuerelementbibliothek und das „ValueButton“-Steuerelement

Erstellen Sie in Visual Studio ein neues Projekt vom Typ Windows Forms-Steuerelementbibliothek, und nennen Sie es ValueButtonLib.

Der Projektname ValueButtonLib wird standardmäßig auch dem Stammnamespace zugewiesen. Der Stammnamespace wird verwendet, um die Namen der Komponenten in der Assembly zu qualifizieren. Wenn z.B. zwei Assemblys Komponenten mit dem Namen ValueButton bereitstellen, können Sie Ihre ValueButton-Komponente mithilfe von ValueButtonLib.ValueButton überprüfen. Weitere Informationen finden Sie unter Namespaces.
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf UserControl1.cs, und wählen Sie im Kontextmenü Umbenennen aus. Ändern Sie den Dateinamen in ValueButton.cs. Klicken Sie auf die Schaltfläche Ja, wenn Sie gefragt werden, ob alle Verweise auf das Codeelement UserControl1 umbenannt werden sollen.
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf ValueButton.cs, und wählen Sie Code anzeigen aus.
Suchen Sie die class-Anweisungszeile, public partial class ValueButton, und ändern Sie den Typ, von dem dieses Steuerelement erbt, von UserControl in Button. Dadurch kann Ihr geerbtes Steuerelement alle Funktionen des Button-Steuerelements übernehmen.
Öffnen Sie im Projektmappen-Explorer den Knoten ValueButton.cs, um die vom Designer generierte Codedatei ValueButton.Designer.cs anzuzeigen. Öffnen Sie diese Datei im Code-Editor.
Suchen Sie die InitializeComponent-Methode, und entfernen Sie die Zeile, die die AutoScaleMode-Eigenschaft zuweist. Diese Eigenschaft ist im Button-Steuerelement nicht vorhanden.
Klicken Sie im Menü Datei auf Alles speichern, um das Projekt zu speichern.

Hinweis

Ein visueller Designer ist nicht mehr verfügbar. Da das Button-Steuerelement seine eigenen Zeichenaktionen vornimmt, können Sie seine Darstellung im Designer nicht ändern. Die visuelle Darstellung entspricht genau der Darstellung der Klasse, von der es erbt (das heißt Button), außer sie wird im Code geändert. Sie können trotzdem Komponenten, die über keine Benutzeroberflächenelemente verfügen, zur Entwurfsoberfläche hinzufügen.

Hinzufügen einer Eigenschaft zum geerbten Steuerelement

Eine Verwendungsmöglichkeit von geerbten Windows Forms-Steuerelementen ist das Erstellen von Steuerelementen, die in Aussehen und Verhalten mit den standardmäßigen Windows Forms-Steuerelementen identisch sind, aber benutzerdefinierte Eigenschaften verfügbar machen. In diesem Abschnitt fügen Sie eine Eigenschaft namens ButtonValue zum Steuerelement hinzu.

So fügen Sie die Value-Eigenschaft hinzu

Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf ValueButton.cs, und klicken Sie im Kontextmenü auf Code anzeigen.
Suchen Sie die Anweisung class. Geben Sie direkt nach { den folgenden Code ein:
```
// Creates the private variable that will store the value of your
// property.
private int varValue;
// Declares the property.
public int ButtonValue
{
   // Sets the method for retrieving the value of your property.
   get
   {
      return varValue;
   }
   // Sets the method for setting the value of your property.
   set
   {
      varValue = value;
   }
}
```
Dieser Code legt die Methoden fest, mit denen die Eigenschaft ButtonValue gespeichert und abgerufen wird. Die get-Anweisung legt den zurückgegebenen Wert auf den Wert fest, der in der privaten Variablen varValue gespeichert ist. Die set-Anweisung legt den Wert der privaten Variablen mithilfe des Schlüsselworts value fest.
Klicken Sie im Menü Datei auf Alles speichern, um das Projekt zu speichern.

Testen des Steuerelements

Steuerelemente sind keine eigenständigen Projekte. Sie müssen in einem Container gehostet werden. Sie müssen ein Testprojekt erstellen, in dem das Steuerelement getestet werden kann. Sie müssen das Steuerelement auch für das Testprojekt zugänglich machen, indem Sie es erstellen (Kompilieren). In diesem Abschnitt erstellen Sie das Steuerelement und testen es in einem Windows Form.

So erstellen Sie das Steuerelement

Klicken Sie im Menü Build auf Projektmappe erstellen. Der Build sollte ohne Compilerfehler oder Warnungen erfolgreich sein.

So Erstellen Sie ein Testprojekt

Zeigen Sie im Menü Datei mit der Maus auf Hinzufügen, und klicken Sie dann auf Neues Projekt, um das Dialogfeld Neues Projekt hinzufügen zu öffnen.
Wählen Sie den Knoten Windows unter dem Knoten Visual C#- aus, und klicken Sie auf Windows Forms-Anwendung.
Geben Sie im Feld Name den Text Test ein.
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Knoten Verweise für Ihr Testprojekt, und wählen Sie dann im Kontextmenü Verweis hinzufügen aus, um das Dialogfeld Verweis hinzufügen anzuzeigen.
Klicken Sie auf die Registerkarte mit der Bezeichnung Projekte. Ihr ValueButtonLib-Projekt wird unter Projektname aufgeführt. Doppelklicken Sie auf das Projekt, um den Verweis auf das Testprojekt hinzuzufügen.
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Test,, und wählen Sie dann Erstellen aus.

So fügen Sie dem Formular ein Steuerelement hinzu

Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Form1.cs, und wählen Sie im Kontextmenü Designer anzeigen aus.
Wählen Sie in der Toolbox die ValueButtonLib-Komponenten aus. Doppelklicken Sie auf ValueButton.

Ein ValueButton wird im Formular angezeigt.
Klicken Sie mit der rechten Maustaste auf ValueButton, und wählen Sie im Kontextmenü Eigenschaften aus.
Untersuchen Sie im Fenster Eigenschaften die Eigenschaften dieses Steuerelements. Beachten Sie, dass sie mit den Eigenschaften identisch sind, die von einer Standardschaltfläche verfügbar gemacht werden, außer es besteht eine zusätzliche Eigenschaft, ButtonValue.
Legen Sie die ButtonValue-Eigenschaft auf 5 fest.
Doppelklicken Sie auf der Registerkarte Alle Windows Forms der Toolbox auf Bezeichnung, um ein Label-Steuerelement zu Ihrem Formular hinzuzufügen.
Verschieben Sie die Bezeichnung in die Mitte des Formulars.
Doppelklicken Sie auf valueButton1.

Der Code-Editor wird im Ereignis valueButton1_Click geöffnet.

Fügen Sie die folgende Codezeile ein.

label1.Text = valueButton1.ButtonValue.ToString();

Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Test, und wählen Sie im Kontextmenü Als Startprojekt festlegen aus.
Wählen Sie im Menü Debuggen die Option Debugging starten.

Form1 wird angezeigt.
Klicken Sie auf valueButton1.

Die Zahl '5' wird in label1 angezeigt und zeigt, dass die Eigenschaft ButtonValue Ihres geerbten Steuerelements mit der Methode valueButton1_Click an label1 weitergegeben wurde. Daher erbt Ihr ValueButton-Steuerelement die gesamte Funktionalität der standardmäßigen Windows Forms-Schaltfläche und macht eine zusätzliche benutzerdefinierte Eigenschaft verfügbar.