Référence du programmeur
<% XMLSPY%> est un serveur d'automatisation : il expose des objets programmables à d'autres applications appelées clients d'automatisation. Un client d'automatisation peut accéder directement aux objets et fonctionnalités mis à disposition par le serveur d'automatisation. Ainsi, un client d'automatisation de XMLSpy peut utiliser, par exemple, la fonctionnalité de validation XML de XMLSpy. Les développeurs peuvent ainsi améliorer leurs applications grâce aux fonctionnalités prêtes à l'emploi de XMLSpy.
Les objets programmables de XMLSpy sont mis à la disposition des clients d'automatisation via l'API d'application de XMLSpy, qui est une API COM. L'API d'application de XMLSpy sera également appelée API d'application à partir de maintenant. Le modèle d'objet de l'API d'application et une description complète de tous les objets disponibles sont fournis ici.
Environnements d'exécution
L'API de l'application est accessible à partir des environnements suivants :
Chacun de ces environnements est brièvement décrit ci-dessous.
Éditeur de scripts : personnalisation et modification des fonctionnalités de XMLSpy
Il est possible de personnaliser votre installation de XMLSpy en modifiant et en ajoutant des fonctionnalités. Vous pouvez également créer des formulaires pour la saisie utilisateur et modifier l'interface utilisateur afin qu'elle contienne de nouvelles commandes de menu et des raccourcis dans la barre d'outils. Toutes ces fonctionnalités sont réalisées en écrivant des scripts qui interagissent avec les objets de l'API de l'application. Pour vous aider à effectuer ces tâches efficacement, XMLSpy vous propose un éditeur de scripts intégré. Une description complète des fonctionnalités disponibles dans l'éditeur de scripts et de leur utilisation est fournie dans la section Éditeur de scripts de cette documentation. Les langages de programmation pris en charge sont JScript et VBScript.
Plug-ins IDE : création de plug-ins pour XMLSpy
XMLSpy vous permet de créer vos propres plug-ins et de les intégrer à XMLSpy. Pour ce faire, vous pouvez utiliser l'interface spéciale de XMLSpy pour les plug-ins. La section Plug-ins IDE XMLSpy décrit comment créer des plug-ins. Un objet d'application est transmis à la plupart des méthodes qui doivent être implémentées par un plug-in IDE et est appelé par l'application. Les langages généralement utilisés pour implémenter un plug-in IDE sont C# et C++. Pour plus d’informations, voir la section Plug-ins IDE XMLSpy.
Programmes externes
De plus, vous pouvez manipuler XMLSpy à l'aide de scripts externes. Par exemple, vous pouvez écrire un script pour ouvrir XMLSpy à un moment donné, puis ouvrir un fichier XML dans XMLSpy, valider le fichier et l'imprimer. Les scripts externes utiliseraient à nouveau l'API de l’application pour effectuer ces tâches. Pour une description de l'API d’application, voir sa documentation.
L'utilisation de l'API d'application depuis l'extérieur de XMLSpy nécessite de démarrer d'abord une instance de XMLSpy. La manière de procéder dépend du langage de programmation utilisé. Pour plus d'informations sur les différents langages, consultez la section de la documentation API intitulée Langages de programmation.
Essentiellement, XMLSpy sera lancé via son enregistrement COM. L'objet Application associé à l'instance XMLSpy est alors renvoyé. En fonction des paramètres COM, un objet associé à un XMLSpy déjà en cours d'exécution peut être renvoyé. Tout langage de programmation prenant en charge la création et l'invocation d'objets COM peut être utilisé. Les plus courants sont répertoriés ci-dessous.
•Les fichiers de script JScript et VBScript ont une syntaxe simple et sont conçus pour accéder aux objets COM. Ils peuvent être exécutés directement à partir d'une ligne de commande DOS ou en double-cliquant dans l'Explorateur Windows. Ils sont particulièrement adaptés aux tâches d'automatisation simples.
•C# est un langage de programmation complet qui offre un large éventail de fonctionnalités existantes. L'accès aux objets COM peut être automatiquement encapsulé à l'aide de C#.
•C++ offre un contrôle direct sur l'accès COM, mais nécessite une quantité de code relativement plus importante que les autres langages.
•Java : les produits Altova sont fournis avec des classes Java natives qui encapsulent l'API de l'application et offrent une apparence et une ergonomie Java complètes.
•Les autres langages de programmation qui constituent des alternatives utiles sont : Visual Basic for Applications, Perl et Python.
Intégration ActiveX
L'accès à l'API d'application via le contrôle ActiveX XMLSpy constitue un cas particulier. Cette fonctionnalité n'est disponible que si le package d'intégration XMLSpy est installé. Chaque contrôle ActiveX possède une propriété qui renvoie un objet COM correspondant à sa fonctionnalité sous-jacente. Le contrôle gestionnaire fournit un objet Application, le contrôle document, un objet Document, et l'objet de remplissage, dans les cas où il contient l'arborescence du projet, renvoie l'objet Projet. Les méthodes prises en charge par ces objets correspondent exactement à celles décrites dans la section Interfaces de l'API de l'application. Il est important de veiller à ne pas utiliser de méthodes qui n'ont pas de sens dans le contexte de l'intégration du contrôle ActiveX. Pour plus de détails, voir Intégration ActiveX.
À propos de la référence des programmeurs
La documentation contenue dans la référence des programmeurs pour XMLSpy comprend les sections suivantes :
•Éditeur de scripts : une référence utilisateur pour l'environnement de script disponible dans XMLSpy.
•Plug-ins IDE : une description de la création de plug-ins pour XMLSpy.
•API d'application : fournit une vue d'ensemble de l'API XMLSpy ; vous redirige vers la documentation de l'API.
•Intégration ActiveX : un guide et une référence sur l'intégration de l'interface graphique XMLSpy et des fonctionnalités XMLSpy à l'aide d'un contrôle ActiveX.