Overview & Setup of the Scripting System

Le système de script d’Altium Designer fournit tous les outils et fonctionnalités nécessaires pour créer des scripts qui automatisent les tâches dans le logiciel.

L’éditeur de scripts, le débogueur et les panneaux de script fonctionnent ensemble pour vous aider à écrire et déboguer facilement vos scripts. Un script peut être exécuté directement depuis l’éditeur de scripts ou affecté à un menu, une barre d’outils ou un raccourci clavier afin de pouvoir être appliqué au document en cours – tel qu’une implantation PCB – à tout moment.

Altium Designer affichant les fenêtres Script Code et Form avec les panneaux Object Inspector, Code Explorer et Tool Palette .

Fonctionnalités du système de script

Le système de script se compose de deux parties principales – l’éditeur et le débogueur. Les principales fonctionnalités sont les suivantes :

• Project access – Les scripts peuvent être enregistrés dans un projet de script ou de conception. Les routines de n’importe quel script d’un projet sont accessibles aux autres scripts du même projet.

• Scripting Editor – L’éditeur de scripts comprend un éditeur de texte dédié avec une gamme d’options permettant de configurer l’environnement d’édition et la coloration syntaxique.

• Scripting Panels – Le système de script comprend plusieurs panneaux qui vous aident à coder et à déboguer rapidement les scripts.

• Scripting Debugger – Si un script comporte une erreur lors de son exécution, une boîte de dialogue s’affiche avec un message d’erreur concis. Vous pouvez prévisualiser les variables dans la fenêtre Watches, suivre le code et contrôler l’exécution du script avec le Script Debugger.

• Scripting Languages – Les scripts peuvent être créés en DelphiScript et, si cette langue héritée est activée, en VBScript.

Unités et formulaires de script

Les projets de script prennent en charge deux types de documents de script – les Script Units et les Script Forms. Les Script Units vous permettent d’écrire des procédures et des fonctions autonomes. Les Script Forms vous permettent de créer des boîtes de dialogue avec des contrôles et des gestionnaires d’événements, ainsi que des procédures et des fonctions.

• Une Script Unit peut utiliser l’interface de programmation d’application (API) X2 pour modifier ou manipuler des objets de conception dans un document de conception. Un Script Form héberge des contrôles en tant qu’interface utilisateur et exploite l’API X2 pour fournir des boîtes de dialogue de script agissant sur les documents de conception actifs.
• Un Script Form est une unité de formulaire visuelle prise en charge par le script. Lorsqu’un formulaire est actif, il représente une fenêtre de dialogue.
• Un Script Form possède deux vues – la vue Script Code et la vue Script Form. La vue Script Code contient les gestionnaires d’événements et les procédures/fonctions. La vue Script Form représente un formulaire de dialogue (de différents types) et comporte des contrôles ainsi que leurs gestionnaires d’événements associés.
• Un Script Form possède deux fichiers associés. Un fichier *.pas qui contient les gestionnaires d’événements et les procédures/fonctions, et un fichier *.dfm qui contient les détails du formulaire de script lui-même ainsi que ses composants et leur emplacement.
• Un composant est un objet de contrôle visuel ou non visuel (placé depuis le panneau Tool Palette panel) qui accepte une entrée utilisateur, telle qu’un clic de souris ou une séquence de caractères saisis. Pendant la conception, le panneau Object Inspector panel peut être utilisé pour manipuler les composants sur un Script Form. Les composants peuvent être utilisés dans n’importe quel Script Form, dans tout ensemble de langages pris en charge par le système de script.
• Un composant (objet de contrôle) possède des méthodes, des propriétés et des événements qui peuvent être utilisés par un Script Form.
  • Les méthodes sont les actions qu’un objet peut effectuer.
  • Les propriétés représentent les données contenues dans l’objet auxquelles il est possible d’accéder ou qui peuvent être modifiées.
  • Les événements sont des conditions auxquelles un composant d’un Script Form peut réagir.
• Un Script Form possède des gestionnaires d’événements qui traitent les conditions capturées, par exemple lorsqu’un bouton du formulaire est cliqué.

Exemples de scripts Altium Designer

Les scripts d’exemple et de référence constituent une ressource utile pour comprendre comment les interfaces d’objet, méthodes, processus, propriétés et composants sont appliqués dans les scripts. Ils peuvent également servir de base à vos propres projets de script.

Exécution d’un exemple

Pour exécuter rapidement un exemple de script dans Altium Designer, ouvrez d’abord un projet d’exemple ou un fichier de script individuel depuis l’un des dossiers d’exemples de scripts – par exemple, le projet simple « Hello World » (HelloWorld.PRJSCR) du dossier Scripts\Delphiscript Scripts\General.

Le projet DelphiScript Hello World ouvert dans le panneau Projects .

Le projet contient deux versions du script « Hello World », dont la seconde (HelloWorlDialog.pas) démontre l’utilisation de base d’une unité Form. Double-cliquez sur un nom de script pour ouvrir et examiner le script dans l’éditeur – notez qu’un script peut être exécuté sans être ouvert dans l’éditeur.

Pour exécuter l’un des scripts, sélectionnez File » Run Script dans les menus principaux, puis choisissez une procédure de script disponible dans la boîte de dialogue Select Item To Run. Lorsqu’une version est exécutée, une boîte de dialogue s’ouvre pour afficher le message.

La manière rapide et simple d’exécuter un script d’exemple.

Configuration du système de script

Préférences

Les paramètres de préférence par défaut du système de script peuvent être configurés dans la boîte de dialogue Preferences, accessible en cliquant sur le bouton de contrôle en haut à droite de l’espace de conception.

Préférences générales

La page Text Editors – General de la boîte de dialogue Preferences vous permet de définir vos exigences d’édition de scripts, telles que le comportement de recherche de chaînes, la manière dont les lignes sont tabulées et indentées, le mappage des touches, ainsi qu’un certain nombre d’autres options avancées.

La page Text Editors – General de la boîte de dialogue Preferences

Préférences de couleur

La page Text Editors – Colors de la boîte de dialogue Preferences vous permet de configurer la coloration syntaxique de l’éditeur de scripts pour le langage de script de votre choix, et de définir la couleur des éléments dans l’éditeur de scripts. Par exemple, noir pour l’arrière-plan, blanc pour les mots-clés de commentaire, etc.

La page Text Editors – Colors de la boîte de dialogue Preferences

Préférences d’affichage

La page Text Editors – Display de la boîte de dialogue Preferences vous permet de configurer les fonctionnalités visuelles des scripts, telles que l’affichage des marges droites et des numéros de ligne, la coloration syntaxique et le plan du code.

La page Text Editors – Display de la boîte de dialogue Preferences

Préférences globales des projets

La page Scripting System – Global Projects de la boîte de dialogue Preferences répertorie les projets de script disponibles (installés). Les projets de script peuvent être installés, supprimés ou réorganisés.

La page Scripting System – Global Projects de la boîte de dialogue Preferences

Préférences du concepteur de formulaires

La page Scripting System – Form Designer de la boîte de dialogue Preferences fournit les options de grille et de désignateur de composant pour un document de formulaire de script.

La page Scripting System – Form Designer de la boîte de dialogue Preferences