Referencia del programador
XMLSpyes un servidor de automatización: expone objetos programables a otras aplicaciones (llamadas clientes de automatización). Un cliente de automatización puede acceder a los objetos y funciones que pone a su disposición el servidor de automatización. De modo que, un cliente de automatización de XMLSpy, puede utilizar, por ejemplo, las funciones de validación XML de XMLSpy. Por consiguiente, los desarrolladores pueden mejorar sus aplicaciones con las funciones predefinidas de XMLSpy.
Los objetos programables de XMLSpy se ponen a disposición de los clientes de automatización a través de la API de aplicación de XMLSpy, que es una API COM. A partir de ahora, la API de aplicación de XMLSpy también se denominará API de aplicación para abreviar. Aquí puede consultar el modelo de objetos de la API de aplicación y una descripción completa de todos los objetos disponibles.
Entornos de ejecución
A la API de aplicación se puede acceder desde estos entornos:
•Desde complementos creados en entornos IDE
A continuación describimos estos entornos brevemente.
El editor de scripts: personalización y modificación de la funcionalidad de XMLSpy
Puede personalizar su instalación de XMLSpy modificando y agregando funcionalidad a la misma. También puede crear formularios y modificar la interfaz del usuario añadiéndole comandos de menú nuevos e iconos nuevos en las barras de herramientas. Para ello basta con escribir scripts que interactúen con objetos de la API de la aplicación. Para ayudarle a llevar a cabo estas tareas de manera eficiente, XMLSpy le ofrece un Editor de scripts integrado. Puede ver una descripción completa de la funcionalidad disponible en el Editor de scripts y cómo debe usarse en la sección Editor de scripts de esta documentación. Los lenguajes de programación compatibles son JScript y VBScript.
Complementos IDE: Creación de complementos para XMLSpy
XMLSpy le permite crear sus propios complementos e integrarlos en XMLSpy. Puede hacerlo utilizando la interfaz especial de XMLSpy para complementos. Puede ver cómo se crean complementos en la sección Complementos de XMLSpy para entornos IDE. Se pasa un objeto de aplicación a la mayoría de los métodos que deben ser implementados por un complemento IDE y se le llama desde la aplicación. Los lenguajes típicos utilizados para implementar un complemento IDE son C# y C++. Para más información consulte, el apartado Complementos de XMLSpy para entornos IDE.
Desde programas externos
Además, puede manipular XMLSpy con scripts externos. Por ejemplo, puede escribir un script para abrir XMLSpy en un momento dado, luego abrir un archivo XML en XMLSpy, validar el archivo e imprimirlo. Los scripts externos utilizan la API de la aplicación para llevar a cabo estas tareas. Para ver una descripción de la API de la aplicación, consulte su documentación.
El uso de la API de la aplicación desde fuera de XMLSpy requiere iniciar una instancia de XMLSpy primero. La manera de iniciar la instancia depende del lenguaje de programación utilizado. Para obtener información sobre cada lenguaje, consulte la sección de la documentación de la API llamada Lenguajes de programación.
Básicamente, XMLSpy se iniciará a través de su registro COM. Luego, se devuelve el objeto Application asociado a la instancia de XMLSpy. Dependiendo de la configuración COM, se puede devolver un objeto asociado con un XMLSpy ya en ejecución. Se puede utilizar cualquier lenguaje de programación que admita la creación e invocación de objetos COM. Los más comunes se enumeran a continuación.
•Los archivos de script JScript y VBScript tienen una sintaxis sencilla y están diseñados para acceder a objetos COM. Se pueden ejecutar directamente desde una línea de comandos DOS o con un doble clic en el Explorador de Windows. Son ideales para tareas de automatización sencillas.
•C# es un lenguaje de programación con un gran número de funciones. El acceso a objetos COM se puede encapsular automáticamente con C#.
•C++ permite un control directo sobre el acceso a COM, pero requiere cantidades de código relativamente grandes en comparación con otros lenguajes.
•Java: los productos Altova vienen con clases Java nativas que envuelven la API de la aplicación y proporcionan un aspecto y una sensación de Java completos.
•Otros lenguajes de programación alternativos son: Visual Basic for Applications, Perl y Python.
La integración con ActiveX
Otra manera de acceder a la API de la aplicación es por medio del control ActiveX de XMLSpy. Esta característica solo está disponible si tiene instalado el paquete de integración de XMLSpy. Todos los controles ActiveX tienen una propiedad que devuelve un objeto COM equivalente para su función subyacente. El control de administrador proporciona un objeto Application, el control de documento un objeto Document y el objeto placeholder, en los casos en que contiene la estructura jerárquica de proyecto, devuelve el objeto Project. Los métodos que admiten estos objetos se describen exactamente en la sección Interfaces de la API de la aplicación . Debe tener cuidado y no utilizar métodos que no tienen sentido en el contexto de la integración para el control ActiveX. Para más información consulte la sección Integración con ActiveX.
Acerca de la referencia del programador
La documentación de la referencia del programador para XMLSpy consta de las siguientes secciones:
•Editor de scripts: una referencia del usuario para el entorno de scripting incluido en XMLSpy
•Complementos para entornos IDE: explica cómo crear complementos para XMLSpy
•API de la aplicación: ofrece un resumen de la API de XMLSpy. Incluye un enlace que le lleva a la documentación de la API.
•Integración para ActiveX: una guía y referencia para aprender a integrar la interfaz gráfica y las funciones de XMLSpy usando el control ActiveX.