Uso de los componentes de formulario de VBScript
De un vistazo
- Crea formularios de script, coloca componentes y configura sus propiedades.
- Muestra cuadros de diálogo modales con ShowModal y gestiona las respuestas de Aceptar y Cancelar.
- Escribe controladores de eventos que respondan a los clics en los botones y comprueben si los campos de texto están vacíos.
Uso de componentes en formularios de VBScript
Aunque los formularios y los componentes se basan en la biblioteca de componentes visuales (VCL) de Embarcadero Delphi™, se sigue utilizando el Tool Palette de Altium Designer basado en Delphi para colocar controles en un formulario al usar VBScript. Además, los controladores de eventos se generan y el código se escribe en lenguaje VBScript, independientemente del origen Delphi de los formularios y componentes de Altium Designer.
Descripción general de los componentes
El sistema de scripting gestiona dos tipos de componentes: visuales y no visuales. Los componentes visuales se utilizan para crear la interfaz de usuario y los no visuales se utilizan para distintas tareas, como las funciones que proporcionan los componentes Timer, OpenDialog y MainMenu. Por ejemplo, el componente no visual Timer se utiliza para activar código específico a intervalos programados y el usuario nunca lo ve. Los componentes Button, Edit y Memo son componentes visuales: el usuario puede verlos.
Ambos tipos de componentes aparecen en tiempo de diseño, pero los componentes no visuales no son visibles en tiempo de ejecución. Los componentes del panel Tool Palette están orientados a objetos y tienen los tres elementos siguientes:
- Propiedades
- Eventos
- Métodos
Una property es una característica de un objeto que influye en su comportamiento visible o en sus operaciones. Por ejemplo, la propiedad Visible determina si este objeto puede verse en un formulario de script.
Un event es una acción o un suceso que detecta el script. En un script, el programador escribe el código de cada controlador de eventos, diseñado para capturar un evento específico, como un clic del ratón.
Un method es un procedimiento que siempre está asociado a un objeto y define su comportamiento.
Todos los formularios de script tienen uno o varios componentes. Por lo general, los componentes muestran información o permiten al usuario realizar una acción. Por ejemplo, una etiqueta se utiliza para mostrar texto estático, un cuadro de edición permite al usuario introducir datos y un botón puede utilizarse para iniciar acciones.
En un formulario se puede colocar cualquier combinación de componentes, lo que permite al usuario interactuar con ellos mientras se ejecuta el script (tiempo de ejecución). Es tarea del programador del script decidir qué sucede cuando un usuario hace clic en un botón o cambia el texto de un cuadro de edición.
El sistema de scripting proporciona una serie de componentes para crear interfaces de usuario sencillas o complejas para los scripts. Todos los componentes que pueden colocarse en un formulario se encuentran en el panel Tool Palette.
Para colocar un componente en un formulario, localice su icono en el panel Tool Palette y haga doble clic en él. Esta acción coloca un componente en el formulario activo en su posición predeterminada, con la anchura y la altura predeterminadas. La representación visual de la mayoría de los componentes viene determinada por su conjunto de propiedades asociadas.
Una vez colocado un componente con su posición, anchura y altura predeterminadas, se puede cambiar su tamaño o posición con el ratón o mediante el panel Object Inspector. Cuando se coloca un componente en un formulario, el sistema de scripting genera automáticamente el código básico necesario para utilizarlo y actualiza el formulario de script. Para que el componente funcione en el formulario, solo queda establecer las propiedades, introducir código en los controladores de eventos y utilizar los métodos necesarios.
Diseño de formularios de script
Un formulario de script está diseñado para interactuar con el usuario dentro del entorno de Altium Designer. El diseño de formularios de script es la base del desarrollo visual en Altium Designer.
Cada componente que se coloca en un formulario de script y cada propiedad que se establece se almacenan en un archivo que describe el formulario (un archivo *.dfm) y guardan relación con el código de script asociado (el archivo *.vbs). Por tanto, para cada formulario de script existe un archivo *.vbs y su correspondiente archivo *.dfm.
Al trabajar con un formulario de script y sus componentes, se puede acceder a sus propiedades y modificarlas mediante el panel Object Inspector. Se pueden seleccionar varios componentes haciendo clic en ellos mientras se mantiene pulsada la tecla Mayús, o arrastrando un rectángulo de selección alrededor de los componentes del formulario de script. El formulario de script tiene un título vinculado a la propiedad Caption del panel Object Inspector.
Creación de un nuevo formulario de script
Con un proyecto de script abierto, haga clic con el botón derecho en el proyecto del panel Projects y seleccione la opción Add New to Project y, a continuación, la opción VB Script Form en los menús contextuales. Se creará un nuevo formulario de script con el nombre predeterminado EditScript1.vbs . Como alternativa, en un proyecto *.PrjPCB, seleccione el comando File » New » Script Files » VB Script Form.
Visualización de un formulario de script
Un script debe tener una rutina que muestre el formulario cuando se ejecute el formulario de script en Altium Designer. Dentro de esta rutina, se invoca el método ShowModal del formulario. La propiedad Visible del formulario debe establecerse en false (desmarcada) para que el método ShowModal del formulario de script funcione correctamente.
Ejemplo de ShowModal
Sub RunDialog
DialogForm.ShowModal
End Sub
El ejemplo ShowModal anterior es una forma sencilla de mostrar el formulario de script cuando se invoca el cuadro de diálogo RunDialog desde el script. Tenga en cuenta que se pueden asignar valores a los componentes del objeto DialogForm antes de invocar el método DialogForm.ShowModal.
El ejemplo ModalResult que se muestra a continuación es más complejo. Sus últimos métodos se utilizan para los botones del formulario de script. Los métodos del script hacen que el cuadro de diálogo se cierre cuando el usuario hace clic en el botón OK o Cancel, lo que devuelve mrOk o mrCancel, respectivamente, desde el método ShowModal.
ModalResult Example
sub bOKButtonClick(Sender)
ModalResult := mrOK
end sub
sub bCancelButtonClick(Sender)
ModalResult := mrCancel
end sub
sub RunShowModalExample
'Form Visible property must be false for ShowModal to work properly.
If Form.ShowModal = mrOk Then ShowMessage("mrOk")
If Form.ShowModal = mrCancel Then ShowMessage("mrCancel")
end sub
Se podría conseguir lo mismo que en el caso anterior estableciendo el valor de ModalResult en mrOk para el botón OK y en mrCancel para el botón Cancel en sus controladores de eventos. Cuando el usuario hace clic en cualquiera de los dos botones, el cuadro de diálogo se cierra. No es necesario llamar al método Close, porque, una vez establecido el método ModalResult, el motor de scripting cierra automáticamente el formulario de script.
Tenga en cuenta que, para establecer el ModalResult del formulario en cancelar cuando el usuario pulse la tecla Esc, debe establecer la propiedad Cancel del botón Cancel en true (marcada) en el panel Object Inspector, o insertar Sender.Cancel := True en el controlador del evento CancelButtonClick del botón del formulario.
Aceptación de entradas del usuario
Uno de los componentes habituales que pueden aceptar entradas del usuario es el componente EditBox. Este componente EditBox tiene un campo de texto en el que el usuario puede escribir una cadena de caracteres. También hay otros componentes que pueden aceptar texto, como el componente de edición con máscara, que es un componente de edición con una máscara de entrada para el campo de texto. La máscara controla o filtra la entrada y se almacena en una cadena de parámetros.
El siguiente ejemplo ilustra lo que ocurre cuando el usuario hace clic en el botón después de escribir texto en el cuadro de edición. Tenga en cuenta que, si el usuario no ha escrito ningún texto en el componente de edición, el controlador de eventos responde con un mensaje de advertencia.
sub TScriptForm.ButtonClick(Sender)
If Edit1.Text = "" Then
ShowMessage("Warning - empty input!")
Exit
End
' do something else for the input
End sub
Tenga en cuenta que el usuario puede desplazar el foco de entrada en el formulario mediante la tecla Tab o haciendo clic en otro control del formulario.
Respuesta a eventos
Cuando un usuario selecciona un formulario o un componente, Altium Designer envía un mensaje al sistema de scripting, que responde a la notificación del evento llamando al método de gestión de eventos correspondiente.
Escritura de gestores de eventos
Un script puede necesitar responder a eventos que afecten a un componente en tiempo de ejecución. Un evento es un vínculo entre una acción en Altium Designer, como hacer clic en un botón, y un fragmento de código que responde a esa acción. El código que responde es un gestor de eventos, que modifica los valores de las propiedades y llama a métodos.
Además de sus propiedades, cada componente tiene un conjunto de nombres de eventos. El programador del script decide cómo reaccionará a las acciones del usuario en Altium Designer. Por ejemplo, cuando un usuario hace clic en un botón de un formulario, Altium Designer envía un mensaje al script y este reacciona al nuevo evento: si se ha definido el evento OnClick de un botón, se ejecuta.
Todos estos componentes también tienen eventos para cuando reciben y pierden el foco. Sin embargo, si no se especifica el código de OnEnter y OnExit (OnEnter: el control tiene el foco; OnExit: el control pierde el foco), el script ignorará el evento.
Propiedades de los componentes
Para ver una lista de las propiedades de un componente, seleccione el componente y active la pestaña Properties del panel Object Inspector.
Eventos de los componentes
Para ver una lista de los eventos a los que puede responder un componente, seleccione el componente y active la pestaña Events del panel Object Inspector. Para crear un procedimiento de gestión de eventos al que pueda responder un componente, elija un evento adecuado y haga doble clic en su nombre.
Por ejemplo, seleccione el componente Button1 en el panel Tool Palette, colóquelo en el formulario del script y haga doble clic junto al nombre del evento OnClick. El sistema de scripting cambiará el foco al editor de código, donde se habrá creado la estructura de código del evento OnClick. Si un botón tiene un método Close en su gestor de eventos CloseClick, al hacer clic en el botón, su gestor de eventos captura el evento de clic y se ejecuta el código que contiene. Es decir, el método Close cierra el formulario del script.
En resumen, para crear un gestor de eventos en un script, seleccione un componente en el formulario o mediante el panel Object Inspector y, a continuación, haga doble clic a la derecha del evento deseado (por ejemplo, OnClick) en la pestaña Events del inspector; la estructura de código correspondiente aparecerá en el script.
Como alternativa, al hacer doble clic en un botón, el sistema de scripting añadirá un gestor para un evento OnClick. Otros tipos de componentes tendrán acciones predeterminadas completamente diferentes.
Métodos de los componentes
Consulte la Referencia de componentes para obtener una lista de los métodos de un componente y consulte la documentación de Embarcadero Delphi para obtener información más detallada.
Creación de componentes en tiempo de ejecución
Los componentes se pueden crear y destruir directamente en un script. Normalmente no es necesario pasar el identificador del formulario, ya que el formulario del script se encarga de ello automáticamente; en su lugar, pase un parámetro Nil al constructor del componente.
Por ejemplo, los cuadros de diálogo Open y Save se pueden crear y destruir (las clases TOpenDialog y TSaveDialog, que forman parte de la RTL de Delphi).