Applikations-API von XMLSpy
Mit Hilfe der COM-basierten API von XMLSpy können andere Applikationen die Funktionalitäten von XMLSpy verwenden. Dadurch können die verschiedensten Aufgaben vom Validieren einer XML-Datei bis zum Ändern von komplexem XML-Inhalt (mit der XMLData Schnittstelle) automatisiert werden.
XMLSpy und die Applikations-API entsprechen den von Microsoft vorgegebenen allgemeinen Spezifikationen für Automation Server. Die Methoden und Eigenschaften der Applikations-API können von gängigen Entwicklungsumgebungen wie z.B. solchen, die C#, C++, VisualBasic und Delphi verwenden, und von von Skript-Sprachen wie JScript und VBScript aufgerufen werden.
Ausführungsumgebungen für die Applikations-API
Die Applikations-API kann über die folgenden Ausführungsumgebungen aufgerufen werden:
•externe Programme (Beschreibung siehe unten und in diesem Abschnitt im Kapitel Übersicht)
•vom integrierten Skript-Editor von XMLSpy aus. Eine Beschreibung zur Skripting-Umgebung finden Sie im Abschnitt Skript-Editor.
•Sie haben in XMLSpy die Möglichkeit, Ihre eigenen Plug-ins zu erstellen und über eine spezielle Schnittstelle für Plug-ins in die Applikation zu integrieren. Eine Beschreibung zur Erstellung von Plug-ins finden Sie im Abschnitt IDE Plug-ins.
•über ein ActiveX Control, das verfügbar ist, wenn das Integration Package installiert wurde. Nähere Informationen dazu finden Sie im Abschnitt ActiveX Integration.
Externe Programme
Im Abschnitt Übersicht dieses Abschnitts wird beschrieben, wie die Funktionalitäten von XMLSpy von externen Programmen aus aufgerufen und automatisiert werden können.
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 unter Programmiersprachen.
Im Wesentlichen wird XMLSpy ü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 eine 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.
Anmerkungen zur Programmierung
Berücksichtigen Sie bitte in Ihrem Client-Code die folgenden Einschränkungen:
•Denken Sie daran, dass bei einem Crash Ihres Client-Code eventuell noch Instanzen von XMLSpyim System laufen.
•Behalten Sie Referenzen auf Objekte - vor allem jene von der XMLData-Schnittstelle - nicht länger als nötig im Arbeitsspeicher. Wenn der Benutzer zwischen zwei Aufrufen Ihres Client Eingaben macht, ist nicht gewährleistet, dass diese Referenzen noch gültig sind.
•Vergessen Sie nicht, Dialogfelder zu deaktivieren, wenn die Benutzeroberfläche nicht sichtbar ist.
•Nähere Informationen, wie Sie lästige Fehlermeldungen vermeiden, finden Sie unter Fehlerbehandlung in JScript(und in C#and Java).
•Geben Sie Referenzen explizit frei, wenn Sie C oder C++ verwenden.
Diese Dokumentation
Die Dokumentation zur Applikations-API ist in zwei Hauptteile gegliedert.
•Der erste Teile besteht aus einer Übersicht, in der das Objektmodell für die API beschrieben wird. Weiters wird beschrieben, wie Sie die API über verschiedene Programmiersprachenaufrufen.
•Der zweite Teil ist ein Referenzteil (Schnittstellenund Enumerationen), der Beschreibungen der Schnittstellenobjekte der Applikations-APIenthält