Formularios y componentes

De un vistazo

Descubre cómo funcionan los formularios y componentes de DelphiScript en Altium Designer, desde la colocación de componentes visuales y no visuales hasta la configuración de propiedades y la respuesta a las acciones del usuario. Este artículo explica cómo crear y mostrar formularios de scripts, gestionar la entrada del usuario y personalizar el comportamiento de los formularios, con ejemplos de código para cuadros de diálogo modales y controladores de eventos. Sigue leyendo para empezar a utilizar estos elementos básicos en tus formularios de scripts.

- Comprende cómo interactúan las propiedades, los eventos y los métodos de los componentes.
- Aprende a añadir componentes y configurar controladores de eventos mediante los paneles Tool Palette y Object Inspector.
- Explora ejemplos para mostrar formularios modales, comprobar si hay campos de entrada vacíos y controlar el comportamiento de los formularios.
Profundiza con IA:

Descripción general de los componentes gráficos

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 componentes no visuales se utilizan para distintas tareas, como los componentes Timer, OpenDialog y MainMenu.

  • El componente no visual Timer se puede utilizar para ejecutar código específico a intervalos programados y nunca es visible para el usuario.
  • Los componentes Button, Edit y Memo son componentes visuales.

Ambos tipos de componentes aparecen durante el diseño, pero los componentes no visuales no son visibles durante la 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 se puede ver o no en un formulario de script.

Un Event es una acción o suceso que detecta el script. En un script, el programador escribe código para 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 más componentes. Por lo general, los componentes muestran información o permiten al usuario realizar una acción. Por ejemplo, un Label se utiliza para mostrar texto estático, un cuadro Edit permite al usuario introducir datos y un Button se puede utilizar para iniciar acciones.

Se puede colocar cualquier combinación de componentes en un formulario y, mientras se ejecuta el script, el usuario puede interactuar con cualquiera de ellos. Es tarea del programador decidir qué sucede cuando un usuario hace clic en un botón o cambia el texto de un cuadro Edit.

El sistema de scripting proporciona una serie de componentes que se pueden utilizar para crear interfaces de usuario complejas para los scripts. Para colocar un componente en un formulario, localice su icono en el panel Paleta de herramientas y haga doble clic en él. Esta acción coloca un componente en el formulario activo. La representación visual de la mayoría de los componentes se configura mediante sus propiedades. Inicialmente, cada componente se coloca en una posición predeterminada del formulario, pero se puede cambiar su posición (arrastrándolo) y su tamaño (estirándolo) según sea necesario. También puede cambiar el tamaño y la posición más adelante mediante el panel Object Inspector .

Cuando se suelta un componente en un formulario, el sistema de scripting genera automáticamente el código necesario para utilizarlo y actualiza el formulario de script. Solo es necesario configurar las propiedades e implementar el código del controlador de eventos para utilizar los métodos deseados y hacer que el componente funcione en el formulario.

Diseño de formularios de script

Un formulario de script está diseñado para interactuar con el usuario dentro del entorno. El diseño de formularios de script es la base del desarrollo visual.

En la práctica, todos los componentes se colocan en un formulario de script y cada propiedad configurada se guarda en un archivo que describe el formulario (un archivo *.DFM), vinculado al código del script asociado (el archivo *.PAS). Para cada formulario de script, existe un archivo .PAS y su correspondiente archivo .DFM.

Al trabajar con un formulario de script y sus componentes, todas las propiedades de los elementos se pueden consultar y modificar mediante el panel Object Inspector. Puede seleccionar varios componentes manteniendo pulsada la tecla Mayús mientras hace clic en ellos, o arrastrando un rectángulo de selección alrededor de los componentes del formulario. Un formulario de script tiene un título (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 un proyecto del panel Projects, haga clic en la opción Add New to Project del menú contextual emergente y elija una opción Delphi Script Form. Se abrirá un nuevo formulario de script con el nombre predeterminado EditScript1.pas.

Visualización de un formulario de script

Un script debe tener un procedimiento que muestre el formulario cuando se ejecute el formulario de script. Dentro de este procedimiento, se puede invocar el método ShowModal del formulario. La propiedad Visible del formulario debe ser false para que el método ShowModal del formulario de script funcione correctamente.

ShowModal example:

Procedure RunDialog;
Begin
  DialogForm.ShowModal;
End;

El ejemplo ShowModal muestra una forma muy sencilla de visualizar el formulario de script cuando se invoca el procedimiento RunDialog. Tenga en cuenta que se pueden asignar valores a los componentes del objeto DialogForm antes de invocar el método DialogForm.ShowModal.

El ejemplo de la propiedad ModalResult que se muestra a continuación es un poco más complejo. Los siguientes métodos del script se utilizan para los botones de un formulario de script. Los métodos 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 desde el método ShowModal, respectivamente.

ModalResult Example:

Procedure TForm.OKButtonClick(Sender: TObject);
Begin
  ModalResult := mrOK;
End;

Procedure TForm.CancelButtonClick(Sender: TObject);
Begin
  ModalResult := mrCancel;
End;

Procedure RunShowModalExample;
Begin
  // Form's Visible property must be false for ShowModal to work correctly.
  If Form.ShowModal = mrOk Then ShowMessage('mrOk');
  If Form.ShowModal = mrCancel Then ShowMessage('mrCancel');
End;
También puede establecer el valor de ModalResult en mrOk para el botón OK y en mrCancel para el botón Cancel en sus controladores de eventos para obtener el mismo resultado anterior.

Cuando el usuario hace clic en cualquiera de los botones de este formulario de script, el cuadro de diálogo se cierra. No es necesario llamar al método Close, ya que, cuando se establece el método ModalResult, el motor de scripting cierra el formulario de script automáticamente.

Tenga en cuenta que, si desea establecer ModalResult del formulario en Cancel cuando un usuario pulse la tecla Esc , utilice el panel Object Inspector para establecer la propiedad Cancel del botón Cancelar en True, o inserte Sender.Cancel := True en el controlador del evento CancelButtonClick del botón del formulario.

Recepción de datos del usuario

Uno de los componentes habituales que puede recibir datos del usuario es el componente TEdit. Este componente tiene un campo en el que el usuario puede escribir una cadena de caracteres. Tenga en cuenta que existen otros componentes de Delphi, como TMaskEdit, que es un componente de edición con una máscara de entrada almacenada en una cadena; esta máscara controla o filtra los datos introducidos.

El siguiente ejemplo ilustra el proceso cuando el usuario hace clic en el botón después de escribir algo en el cuadro de edición. Si el usuario no ha escrito nada en el componente de edición (está vacío), el controlador de eventos responde con un mensaje de advertencia.

Procedure TScriptForm.ButtonClick(Sender : TObject);
Begin
  If Edit1.Text = '' Then
  Begin
    ShowMessage('Warning - empty input!');
    Exit;
  End;
  // do something else for the input
End;

Tenga en cuenta que el usuario puede cambiar el foco de entrada del cuadro de diálogo mediante la tecla Tab o haciendo clic en otro control del formulario.

Respuesta a eventos

Cuando se hace clic en un botón de un formulario o en un componente, el sistema de scripting responde recibiendo una notificación de evento de Altium Designer y llamando al método controlador de eventos correspondiente.

See also
El proyecto HelloWorld de la carpeta Scripts\DelphiScript Scripts\General\ de la colección de scripts.
El script de ejemplo ShowModal de la carpeta Scripts\DelphiScript Scripts\General\ de la colección de scripts.

Escritura de controladores de eventos

Cada componente de un script de formulario tiene un conjunto de nombres de eventos que utilizan los controladores de eventos del script para determinar cómo reaccionará el script 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 especificado el evento OnClick de un botón, se ejecuta.

El código para responder a los eventos suele incluirse en los controladores de eventos de DelphiScript, y todos los componentes tienen un conjunto de eventos a los que pueden reaccionar. Por ejemplo, todos los componentes en los que se puede hacer clic tienen un evento OnClick que se activa cuando un usuario hace clic en ellos. Todos estos componentes también tienen eventos para cuando reciben y pierden el foco. Sin embargo, si no se ha especificado el código de OnEnter y OnExit (OnEnter: el control ha recibido el foco; OnExit: el control ha perdido el foco), el script ignorará el evento.

En resumen, un evento es un vínculo entre una acción que ocurre 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 controlador de eventos. Este código modifica los valores de las propiedades y llama a métodos.

Propiedades de los componentes

Para ver una lista de las propiedades de un componente, selecciónelo y abra la pestaña Properties del panel Object Inspector.

Eventos de los componentes

Para ver una lista de los eventos a los que puede reaccionar un componente, selecciónelo y abra la pestaña Events del panel Object Inspector. Para crear un procedimiento de gestión de eventos, seleccione el evento al que desea que reaccione el componente y haga doble clic en su nombre: el sistema de scripts insertará automáticamente el código base del controlador de eventos.

Por ejemplo, seleccione el componente TButton del panel Tool Palette y colóquelo en el formulario del script; a continuación, haga doble clic junto al nombre del evento OnClick en el panel Object Inspector . El sistema de scripts llevará el foco al editor de código y creará el código base del evento OnClick.

Por ejemplo, si un botón tiene un método Close en el controlador de eventos CloseClick, al hacer clic en el botón, su controlador de eventos capturará el evento OnClick, lo que provocará la ejecución del código que contiene. Como resultado, el método Close cerrará el formulario del script.

En resumen, seleccione un componente de botón en el formulario o mediante el panel Object Inspector, seleccione la página Events y haga doble clic en el lado derecho del evento OnClick; aparecerá un nuevo controlador de eventos en el script. Como alternativa, haga doble clic en el propio botón y el sistema de scripts añadirá un controlador para este evento OnClick. Tenga en cuenta que otros tipos de componentes tendrán acciones predeterminadas diferentes.

Métodos de los componentes

Para ver una lista de los métodos de un componente, consulte el documento Referencia de componentes.

Colocar componentes en un formulario de script

Para utilizar componentes del panel Tool Palette en un script, debe existir un formulario de script en el que colocarlos. Normalmente, al colocar componentes en un formulario de script, no es necesario crear ni destruir estos objetos: el formulario de script lo hace automáticamente.

El sistema de scripts también genera automáticamente el código necesario para utilizar un componente y actualiza el formulario del script. Después, solo queda configurar las propiedades, introducir código en los controladores de eventos y utilizar los métodos necesarios para implementar un formulario de script funcional.

Crear componentes en un script

Los componentes se pueden crear o destruir directamente en un script pasando un parámetro Nil al Constructor de un componente. Normalmente no es necesario pasar el identificador del formulario, ya que el formulario del script se encarga de ello automáticamente. Por ejemplo, puede crear y destruir los cuadros de diálogo Open y Save (clases TOpenDialog y TSaveDialog de la RTL de Embarcadero Delphi).

Personalizar formularios de script

Los puntos esenciales para personalizar formularios de script son:

  • Para forzar que un formulario permanezca por encima de los demás paneles abiertos, establezca la propiedad FormStyle en fsStayOnTop.
  • Para definir el comportamiento predeterminado de un formulario, establezca FormKind en uno de los siguientes valores: fkNone, fkNormal, fkServerPanel o fkModal.
  • Si fkModal está cerrado, el formulario será modal; es decir, esperará una entrada del usuario antes de continuar, como cerrar el formulario. Si fkServerPanel, el formulario se mostrará como un panel de servidor. Si fkNormal, el formulario actuará como un formulario no modal normal.
  • Para eliminar las barras de desplazamiento predeterminadas del formulario, cambie el valor de las propiedades HorzScrollBar y VertScrollBar.
  • Para convertir el formulario en un marco MDI o en un formulario secundario MDI, utilice la propiedad FormStyle.
  • Para cambiar el estilo del borde del formulario, utilice las propiedades BorderIcons y BorderStyle (los resultados son visibles en tiempo de ejecución).
  • Para cambiar el icono del formulario minimizado, utilice la propiedad Icon.
  • Para especificar la posición inicial de un formulario en la ventana de la aplicación, utilice la propiedad Position.
  • Para especificar el estado inicial del formulario (por ejemplo, minimizado, maximizado o normal), utilice la propiedad WindowState.
  • Para definir el área de trabajo del formulario en tiempo de ejecución, utilice las propiedades ClientHeight y ClientWidth (tenga en cuenta que ClientHeight y ClientWidth representan el área dentro del borde del formulario; Height y Width representan toda el área del formulario).
  • Para especificar qué control tiene el foco inicial en el formulario en tiempo de ejecución, utilice la propiedad ActiveControl.
  • Para pasar todos los eventos del teclado al formulario, independientemente del control seleccionado, utilice la propiedad KeyPreview.
  • Para especificar un menú concreto, si un formulario contiene más de uno, utilice la propiedad Menu.

Actualizar formularios y componentes de scripts

Cuando la superficie de un formulario de script queda desactualizada, por ejemplo, cuando los controles no se actualizan ni se redibujan, estos pueden parecer bloqueados o dañados. Esto puede deberse a un procesamiento intensivo en segundo plano por parte de ese script.

El método Update del formulario de script y de muchos de los componentes de script del panel Tool Palette permite actualizar el contenido gráfico del formulario o de los controles específicos. Las líneas que contienen el método Update están resaltadas en gris en el siguiente ejemplo.

StatusBar component and its Update method Example:

Procedure TConverterForm.loadbuttonClick(Sender: TObject);
Begin
 If OpenPictureDialog1.Execute then
 Begin
 XPProgressBar1.Position := 0;
 XStatusBar1.SimpleText  := '  Loading...';
 XStatusBar1.Update;
 
 // loading a monochrome bitmap only
 Image1.Picture.LoadFromFile(OpenPictureDialog1.FileName);
 
 // Check if image is monochrome, otherwise prompt a warning
 If Image1.Picture.Bitmap.PixelFormat <> pf1bit Then
 Begin
 ShowWarning('The image is not a monochrome!');
 Close;
 End;
 
 lImageSize.Caption := IntToStr(Image1.Picture.Width) + ' x ' +
 IntToStr(Image1.Picture.Height) + ' mils';
 
 convertbutton.Enabled  := True;
 LoadButton.Enabled     := False;
 XStatusBar1.SimpleText := '  Ready...';
 XStatusBar1.Update;
 End;
End;

El fragmento de código anterior pertenece al proyecto de script PCB Logo Creator, que se encuentra en la carpeta Scripts\Delphiscript Scripts\Pcb\PCB Logo Creator de la colección de scripts descargable.

AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Nav
Contents
Disponibilidad de funciones

Las funciones disponibles para usted dependen de qué solución de Altium tenga: Altium Develop, Altium Agile Teams, Altium Agile Enterprise o Altium Designer (con suscripción activa).

Si no ve una función documentada en su software actual, contacte con Ventas de Altium para obtener más información.

Documentación heredada

La documentación de Altium Designer ya no está versionada. Si necesita acceder a la documentación de versiones anteriores de Altium Designer, visite la sección Documentación heredada de la página de Otros instaladores.

Contents