Referencia del programador

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio > 

Referencia del programador

XMLSpy es un servidor de automatización: expone objetos programables a otras aplicaciones, que se denominan clientes de automatización. Como resultado los clientes de automatización pueden tener acceso directo a los objetos y a las funciones que pone a su disposición el servidor de automatización. Por ejemplo, los clientes de automatización de XMLSpy pueden usar la función 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 por medio de la API de XMLSpy, que es una API de COM. En adelante usaremos el término "API de la aplicación" para referirnos a la API de XMLSpy. En la presente documentación describimos el modelo de objetos de la API de la aplicación y todos los objetos disponibles (consulte la sección API de la aplicación).

 

Entornos de ejecución

A la API de la aplicación se puede acceder desde estos entornos:

 

El editor de scripts
Los complementos para entornos IDE
Programas externos
La integración con ActiveX

 

A continuación describimos estos entornos brevemente.

 

Editor de scripts: personalizar y modificar las funciones de XMLSpy

Puede personalizar su instalación de XMLSpy modificando sus funciones o agregando funciones nuevas. También puede crear formularios y modificar la interfaz del usuario añadiendo comandos  de menú e iconos nuevos. Para ello basta con escribir scripts que interactúen con objetos de la API de la aplicación. A fin de ayudarle a realizar estas tareas de forma eficaz, XMLSpy viene con un editor de scripts integrado. Para más información sobre las funciones del editor de scripts e instrucciones de uso, consulte la sección Editor de scripts de esta referencia. Los lenguajes de programación compatibles con el editor de scripts son JScript y VBScript.

 

Complementos para entornos IDE: crear complementos para XMLSpy

En XMLSpy puede crear sus propios complementos e integrarlos en XMLSpy. Para ello puede usar la interfaz especial de XMLSpy para complementos. Para más información sobre cómo crear complementos, consulte la sección Complementos para entornos IDE.

 

Un objeto de la aplicación se pasa a la mayoría de los métodos que debe implementar el complemento para entornos IDE y la aplicación llama al objeto. Los lenguajes que se suelen utilizar para implementar un complemento para entornos IDE son C# y C++. Para más información, consulte la sección Complementos para entornos IDE.

 

Programas externos

También puede manipular XMLSpy con scripts externos. Por ejemplo, puede escribir un script para abrir XMLSpy a una hora concreta, abrir un archivo XML en XMLSpy, validarlo e imprimirlo. Los scripts externos utilizan la API de la aplicación para llevar a cabo estas tareas. Para más información, consulte la sección API de la aplicación.

 

Para usar la API de la aplicación desde fuera de XMLSpy es necesario iniciar una instancia de XMLSpy primero. La manera de iniciar la instancia de XMLSpy depende del lenguaje de programación utilizado. Para más información consulte el apartado Lenguajes de programación.

 

Básicamente XMLSpy se inicia por medio de su registro COM. Después se devuelve el objeto Application asociado con la instancia de XMLSpy. Dependiendo de la configuración COM, puede devolverse un objeto asociado con una instancia de XMLSpy que ya se esté ejecutando. Puede utilizarse cualquier lenguaje de programación que permita crear e invocar objetos COM. A continuación enumeramos los más comunes:

 

Los archivos de script de JScript y VBScript tienen una sintaxis sencilla y están diseñados para acceder a objetos COM. Pueden ejecutarse directamente desde la línea de comandos de DOS o al hacer doble clic en ellos desde 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 de Altova vienen con clases nativas de Java, que encapsulan la API de la aplicación y ofrecen un entorno similar a Java.
Otros lenguajes de programación que pueden ser útiles son Visual Basic for Applications, Perl y Python.

 

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 sólo 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 del administrador ofrece un objeto Application, el control de documentos ofrece un objeto Document y el objeto marcador de posición, si contiene un árbol de proyecto, devuelve el objeto Project. Los métodos compatibles con estos objetos se describen en detalle en el apartado Interfaces de la sección 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 Referencia del programador de la documentación de XMLSpy se divide en estas 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: una referencia de la API de la aplicación
Integración para ActiveX: una guía y referencia para aprender a integrar la IGU y las funciones de XMLSpy usando el control ActiveX

 


© 2019 Altova GmbH