Referenz für Programmierer
XMLSpy ist ein Automation Server, d.h. es stellt anderen Applikationen, so genannten Automation Clients, programmierbare Objekte zur Verfügung. Ein Automation Client hat direkten Zugriff auf die vom Automation Server bereitgestellten Objekte und Funktionalitäten, sodass sich der Automation Client von XMLSpy z.B. die XML-Validierungsfunktionalität von XMLSpy zunutze machen kann. Dadurch können Sie von anderen Applikationen aus die fertigen Funktionen von XMLSpy nutzen.
Die programmierbaren Objekte von XMLSpy stehen den Automation Clients über die Applikations-API von XMLSpy, eine COM API, zur Verfügung. Die Applikations-API von XMLSpy wird in dieser Dokumentation in der Folge auch als Applikations-API bezeichnet. Das Objektmodell der Applikations-API und eine vollständige Beschreibung aller verfügbaren Objekte finden Sie hier.
Ausführungsumgebungen
Die Applikations-API kann von den folgenden Umgebungen aus aufgerufen werden:
Im Folgenden finden Sie eine Beschreibung der einzelnen Umgebungen.
Skript-Editor: Anpassen von XMLSpy und Ändern der Funktionalität des Programms
Sie können Ihre Installation von XMLSpy anpassen, indem Sie sie ändern und Funktionalitäten dazu hinzufügen. Sie können auch Formulare für die Benutzereingabe erstellen und neue Menübefehle und Symbolleisten-Schaltflächen zur Benutzeroberfläche hinzufügen. Zu diesem Zweck werden Skripts geschrieben, die mit Objekten der Applikations-API interagieren. Zur effizienten Ausführung dieser Aufgaben steht in XMLSpy ein integrierter Skript-Editor zur Verfügung. Eine ausführliche Beschreibung der im Skript-Editor verfügbaren Funktionalitäten und eine Anleitung zur Verwendung der Skripting-Umgebung finden Sie im Abschnitt Skript-Editor dieser Dokumentation. Unterstützt werden die Programmiersprachen JScript und VBScript.
IDE Plug-ins: Erstellen von Plug-ins für XMLSpy
Sie haben in XMLSpy die Möglichkeit Ihre eigenen Plug-Ins zu schreiben und in XMLSpy zu integrieren. Dazu können Sie die spezielle XMLSpy-Schnittstelle für Plug-ins verwenden. Eine Beschreibung zur Erstellung von Plug-ins finden Sie im Abschnitt XMLSpy IDE Plug-ins. An die meisten Methoden, die von einem IDE Plug-in, das von der Applikation aufgerufen wird, implementiert werden müssen, wird ein Applikationsobjekt übergeben. Häufig werden zur Implementierung eines IDE Plug-in die Programmiersprachen C# und C++ verwendet. Nähere Informationen finden Sie im Abschnitt XMLSpy IDE Plug-ins.
Externe Programme
Außerdem können Sie XMLSpy mittels externer Skripts bedienen. So könnten Sie z.B. ein Skript schreiben, um XMLSpy zu einem bestimmten Zeitpunkt zu öffnen, anschließend eine XML-Datein in XMLSpy zu öffnen, die Datei zu validieren und auszudrucken. Externe Skripts würden sich zur Ausführung dieser Aufgaben wiederum der Applikations-API bedienen. Eine Beschreibung der Applikations-API finden Sie in der Dokumentation dazu.
Um die Applikations-API außerhalb von XMLSpy verwenden zu können, muss zuerst eine Instanz von XMLSpy gestartet werden. Wie dies erfolgt, hängt von der verwendeten Programmiersprache ab. Nähere Informationen zu den einzelnen Sprachen finden Sie in der API-Dokumentation im Abschnitt Programmiersprachen.
XMLSpy wird im Prinzip über seine COM Registrierung gestartet. Anschließend wird das mit der XMLSpy-Instanz verknüpfte Application-Objekt zurückgegeben. Je nach COM-Einstellungen kann ein mit einer bereits laufenden XMLSpy-Instanz verknüpftes Objekt zurückgegeben werden. Es kann jede Programmiersprache verwendet werden, die die Erstellung und den Aufruf von COM-Objekten unterstützt. Die am häufigsten dazu verwendeten Sprachen sind unten aufgelistet.
•JScript und VBScript Skript-Dateien haben eine einfache Syntax und dienen dazu COM-Objekte aufzurufen. Sie können direkt über die DOS-Befehlszeile oder durch Doppelklick im Windows Explorer ausgeführt werden. Am besten eignen sich diese Sprachen für einfache Automationsaufgaben.
•C# ist eine umfangreiche Programmiersprache mit einer breiten Palette an Funktionalitäten. Der Zugriff auf COM-Objekte kann in C# automatisch über Wrapper erfolgen.
•C++ ermöglicht die direkte Steuerung des COM-Zugriffs. Allerdings muss dafür im Vergleich zu anderen Sprachen relativ viel Code geschrieben werden.
•Java: Im Lieferumfang von Altova-Produkten sind native Java-Klassen inkludiert, die als Wrapper für die Applikations-API verwendet werden und dadurch eine Java-Umgebung ermöglichen.
•Weitere nützliche Alternativen sind Visual Basic für Applikationen, Perl und Python.
ActiveX Integration
Ein Sonderfall ist der Aufruf der Applikations-API über das XMLSpy ActiveX Control. Diese Funktion steht nur zur Verfügung, wenn das XMLSpy Integration Package installiert ist. Jedes ActiveX Control hat eine Eigenschaft, die das entsprechende COM-Objekt für die zugrunde liegende Funktionalität zurückgibt. Das Manager Control liefert ein Application-Objekt, das Document Control ein Document-Objekt und das Platzhalterobjekt gibt, wenn es die Projektstruktur enthält, das Project-Objekt zurück. Die von diesen Objekten unterstützten Methoden sind genau die gleichen, wie im Abschnitt "Interfaces" der Applikations-API beschrieben. Achten Sie darauf, keine Methoden zu verwenden, die keinen Sinn im Zusammenhang mit der ActiveX Control Integration ergeben. Nähere Informationen dazu finden Sie unter ActiveX Integration.
Informationen über die Referenz für Programmierer
Die XMLSpy-Referenz für Programmierer besteht aus den folgenden Abschnitten:
•Skript-Editor: eine Benutzerreferenz für die Skripting-Umgebung in XMLSpy
•IDE Plug-ins: eine Anleitung zum Erstellen von Plug-ins für XMLSpy
•Applikations-API: bietet eine Übersicht über die XMLSpy API; Sie gelangen über diesen Link zur API-Dokumentation.
•ActiveX Integration: Anleitung und Referenz zur Integration der Benutzeroberfläche und Funktionalitäten von XMLSpy mit Hilfe eines ActiveX Control.