Code-Beispiel
Ein Beispiel zum Einsatz der Klasse System.ComponentModel.Component aus der .NET-Klassenbibliothek.
Autor: Dr. Holger Schwichtenberg
Beschreibung
Der Server Explorer in Visual Studio .NET ist ein Werkzeug, um verschiedene Systembausteine (z.B. Ereignisprotokolle, Dienste, Leistungsindikatoren, Datenbanken) zu betrachten, zu verändern (z.B. starten, stoppen, leeren) und per Drag&Drop in eigene Anwendungen zu integrieren.
In der Beta1 von Visual Studio .NET gab es auch noch einen Zweig für WMI-Klassen. Dieser ist nun ein kostenloses Add-n für Visual Studio .NET mit dem Namen "Management (WMI) Extensions for VS.NET Server Explorer".
Nach der Installation dieses Add-ons gibt es im Server Explorer zwei neue Äste: MANAGEMENT CLASSES und MANAGEMENT EVENTS.
MANAGEMENT CLASSES zeigt eine vordefinierte Menge von WMI-Klassen an. Sie können jede andere Klasse dort integrieren (Kontextmenüpunkt ADD). Das Eigenschaftsfenster zeigt die Attribute der Klasse. Dabei stehen auch die Beschreibungstexte, die im WMI-Repository hinterlegt sind, zur Verfügung.
Unterhalb jeder Klasse kann man die Instanzen einblenden; das Eigenschaftsfenster zeigt dann die Attributwerte der gewählten Instanz. Im Kontextmenü können die Methoden der WMI-Klasse auf dem betreffenden Objekt aufgerufen werden.
Der Zweig MANAGEMENT EVENTS dient dazu, WMI-Ereignisabfragen zu definieren.
Nutzung im Designer
Visual Studio .NET besitzt auch einen Designer für nicht-visuelle Komponenten im Rahmen der VS.NET-Elementtypen WINDOWS FORM, WEB FORM oder COMPONENT. Jeder per Drag&Drop auf den Designer abgelegte Systembaustein erscheint als ein Icon mit Namen und kann über das Eigenschaftsfenster konfiguriert werden.
Da weder die Anordnung der Elemente konfiguriert werden kann, noch eine weitere grafische Nutzung (z.B. Verbindung von Attributen durch Linien) möglich ist, ist der Begriff "Designer" hier aber etwas hochgegriffen.
Auch WMI-Klassen, die visuelle Systembausteine repräsentieren, werden wie nicht-visuelle Systembausteine behandelt, da es bisher keine besonderen Design-Time-Controls für WMI-Klassen gibt.
Neben der Möglichkeit, die Attribute der Instanz zu betrachten, liegt der Vorteil darin, dass der Server Explorer automatisch die Management Strongly Typed Class Generation anstößt und den Code für die Instanziierung generiert. Dieser Code wird in einer Region mit Namen "Component Designer Generated Code" zusammengefasst. Aus dem eigenen Programmcode heraus kann der Entwickler dann die WMI-Instanz über den im Designer vergebenen Namen ansprechen.
Beispiel
Das folgende Listing zeigt den vom Visual Studio .NET-Designer für die vier WMI-Instanzen generierten Programmcode. Außerdem wird anhand der selbst geschriebenen Routine testprinter() gezeigt, wie man die PrinterHP genannte Instanz der Klasse CIMV2.Printer nutzen kann. Die Routine druckt erst die Testseite aus und gibt den Drucker dann als Netzdrucker frei.
Programmcodebeispiele Visual Basic .NET (VB.NET)
' ============================
' .NET-Code-Beispiel in Visual Basic .NET
' Drucken einer Testseite und Freigeben des Druckers
' Variante #1
' (C) Holger@Schwichtenberg.de
' ============================
Public Class WMI_visuell
Inherits System.ComponentModel.Component
Region " Component Designer generated code "
Public Sub New(Container As System.ComponentModel.IContainer)
MyClass.New()
'Required for Windows.Forms Class Composition Designer support
Container.Add(me)
End Sub
Public Sub New()
MyBase.New()
'This call is required by the Component Designer.
InitializeComponent()
'Add any initialization after the InitializeComponent() call
End Sub
'Component overrides dispose to clean up the component list.
Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing Then
If Not (components Is Nothing) Then
components.Dispose()
End If
End If
MyBase.Dispose(disposing)
End Sub
'Required by the Component Designer
Private components As System.ComponentModel.IContainer
'NOTE: The following procedure is required by the Component Designer
'It can be modified using the Component Designer.
'Do not modify it using the code editor.
Friend WithEvents AppLog As FCL_Buch.ROOT.CIMV2.NTEventlogFile
Friend WithEvents LaufwerkC As FCLBuch.ROOT.CIMV2.LogicalDisk
Friend WithEvents PrinterHP As FCLBuch.ROOT.CIMV2.Printer
Friend WithEvents FaxDienst As FCLBuch.ROOT.CIMV2.Service
<System.Diagnostics.DebuggerStepThrough()> Private Sub InitializeComponent()
Me.AppLog = New FCL_Buch.ROOT.CIMV2.NTEventlogFile()
Me.LaufwerkC = New FCLBuch.ROOT.CIMV2.LogicalDisk()
Me.PrinterHP = New FCLBuch.ROOT.CIMV2.Printer()
Me.FaxDienst = New FCLBuch.ROOT.CIMV2.Service()
'
'AppLog
Me.AppLog.Path = New System.Management.ManagementPath("\\MARS\root\CIMV2:Win32NTEventlogFile.Name=""C:\\WINDOWS\\system32\\config\\AppEv" &
"ent.Evt""")
'
'Laufwerk_C
Me.LaufwerkC.Path = New System.Management.ManagementPath("\\MARS\root\CIMV2:Win32LogicalDisk.DeviceID=""C:""")
'
'Printer_HP
Me.PrinterHP.Path = New System.Management.ManagementPath("\\MARS\root\CIMV2:Win32Printer.DeviceID=""HP2100""")
'
'Fax_Dienst
Me.FaxDienst.Path = New System.Management.ManagementPath("\\MARS\root\CIMV2:Win32Service.Name=""Fax""")
End Sub
Region "Eigener Code von Holger Schwichtenberg"
Sub test_printer()
Dim name As String = Printer_HP.Name
out("Drucke Testseite auf " & name)
Printer_HP.PrintTestPage()
out("Testseite gedruckt!")
out("Drucker wird freigegeben")
Printer_HP.Shared = True
Printer_HP.ShareName = "HP2100"
out("Drucker wurde freigegeben!")
End Sub
End Region
Programmcodebeispiele CSharp (C#)
using System;
using System.ComponentModel;
using System.Collections;
using System.Diagnostics;
namespace FCLBuch._SystemManagement {
public class WMI_visuell : System.ComponentModel.Component {
private FCL_Buch.ROOT.CIMV2.LogicalDisk logicalDisk1;
private FCL_Buch.ROOT.CIMV2.Printer printer1;
private System.ComponentModel.Container components = null;
public WMI_visuell(System.ComponentModel.IContainer container) {
///
/// Erforderlich für Windows.Forms Klassenkompositions-Designerunterstützung
///
container.Add(this);
InitializeComponent();
}
public WMI_visuell() {
///
/// Erforderlich für Windows.Forms Klassenkompositions-Designerunterstützung
///
InitializeComponent();
}
/// <summary>
/// Verwendete Ressourcen bereinigen.
/// </summary>
protected override void Dispose( bool disposing ) {
if( disposing ) {
if(components != null) {
components.Dispose();
}
}
base.Dispose( disposing );
}
#region Vom Komponenten-Designer generierter Code
/// <summary>
/// Erforderliche Methode für die Designerunterstützung.
/// Der Inhalt der Methode darf nicht mit dem Code-Editor geändert werden.
/// </summary>
private void InitializeComponent() {
this.logicalDisk1 = new FCL_Buch.ROOT.CIMV2.LogicalDisk();
this.printer1 = new FCL_Buch.ROOT.CIMV2.Printer();
//
// logicalDisk1
//
this.logicalDisk1.Path = new System.Management.ManagementPath("\\\\DAGOBAR\\root\\CIMV2:Win32_LogicalDisk.DeviceID=\"C:\"");
//
// printer1
//
this.printer1.Path = new System.Management.ManagementPath("\\\\DAGOBAR\\root\\CIMV2:Win32_Printer.DeviceID=\"\\\\\\\\CORUSCANT\\\\LaserPrinter\"");
}
#endregion
}
}
Hinweise
Ausgaben werden in den Beispielen durch Hilfsroutinen wie out() und
PrintOut() erzeugt. Diese sind hier nicht angegeben, da deren Implementierung
von der jeweiligen Umgebung abhängt. Für Konsolenanwendungen können hier z.B.
Console.WriteLine() einsetzen.
Querverweise
Liste aller Codebeispiele
Definition '.NET Framework Class Library'
Verfügbarkeit der Klasse 'System.ComponentModel.Component'
Übersicht über den FCL-Namensraum 'System.ComponentModel'
.NET & Visual Studio Community Portal