Altova XMLSpy 2024 Professional Edition

Programming languages differ in the way they support COM access. A few examples for the most frequently used languages (links below) will help you get started. The code listings in this section show how basic functionality can be accessed. The files in the API subfolder of the Examples folder can be used to test this functionality:



Windows 7, Windows 8, Windows 10, Windows 11




The JScript listings demonstrate the following basic functionality:


Start application or attach to a running instance

Simple document access


Error handling


Import and export of data



VBScript is different than JScript only syntactically; otherwise it works in the same way. The link below goes to an example of how VBScript can be used. For more information, refer to the JScript examples.


Events: Shows how events are handled using VBScript.



C# can be used to access the Application API functionality. The code listings show how to access the API for certain basic functionality.


Start XMLSpy: Starts XMLSpy, which is registered as an automation server, or activates the program if XMLSpy is already running.

Open OrgChart.pxf: Locates one of the example documents installed with XMLSpy and opens it. If this document is already open it becomes the active document.

OnDocumentOpened Event On/Off: Shows how to listen to XMLSpy events. When turned on, a message box will pop up after a document has been opened.

Open ExpReport.xml: Opens another example document.

Toggle View Mode: Changes the view of all open documents between Text View and Authentic View. The code shows how to iterate through open documents.

Validate: Validates the active document and shows the result in a message box. The code shows how to handle errors and COM output parameters.

Shutdown XMLSpy: Stops XMLSpy.



The XMLSpy API can be accessed from Java code. The Java sub-section of this section explains how some basic XMLSpy functionality can be accessed from Java code. It is organized into the following sub-sections:


Mapping Rules for the Java Wrapper

Example Java Project

Application Startup and Shutdown

Simple Document Access


Use of Out-Parameters

Event Handlers


© 2018-2024 Altova GmbH