Overview & Setup of the Scripting System

Das Skriptsystem von Altium Designer stellt alle Werkzeuge und Funktionen bereit, die zum Erstellen von Skripten erforderlich sind, mit denen Aufgaben in der Software automatisiert werden.

Der Skripteditor, der Debugger und die Skript-Panels arbeiten zusammen, damit Sie Ihre Skripte einfach schreiben und debuggen können. Ein Skript kann direkt aus dem Skripteditor ausgeführt oder einem Menü, einer Symbolleiste oder einem Hotkey zugewiesen werden, sodass es jederzeit auf das aktuelle Dokument – beispielsweise ein PCB-Layout – angewendet werden kann.

Altium Designer mit den Fenstern „Script Code“ und „Form“ sowie den Object Inspector, Code Explorer und Tool Palette Panels.

Funktionen des Skriptsystems

Das Skriptsystem besteht aus zwei Hauptteilen – dem Editor und dem Debugger. Die wichtigsten Funktionen sind:

• Project access – Skripte können in einem Skript- oder Designprojekt gespeichert werden. Routinen aus jedem Skript in einem Projekt sind für andere Skripte innerhalb desselben Projekts zugänglich.

• Scripting Editor – Der Skripteditor verfügt über einen dedizierten Texteditor mit einer Reihe von Optionen zum Einrichten der Bearbeitungsumgebung und der Syntaxhervorhebung.

• Scripting Panels – Das Skriptsystem bietet eine Reihe von Panels, mit denen Sie Skripte schnell codieren und debuggen können.

• Scripting Debugger – Wenn ein Skript bei der Ausführung einen Fehler aufweist, erscheint ein Dialog mit einer kurzen Fehlermeldung. Sie können Variablen im Watches-Fenster anzeigen, den Code nachverfolgen und die Ausführung des Skripts mit dem Script Debugger steuern.

• Scripting Languages – Skripte können in DelphiScript und – sofern als Legacy-Sprache aktiviert – in VBScript erstellt werden.

Skripteinheiten und Formulare

Skriptprojekte unterstützen zwei Arten von Skriptdokumenten – Script Units und Script Forms. Script Units ermöglichen das Schreiben eigenständiger Prozeduren und Funktionen. Script Forms ermöglichen das Erstellen von Dialogen mit Steuerelementen und Event-Handlern sowie von Prozeduren und Funktionen.

• Eine Script Unit kann die X2 Application Programming Interface (API) verwenden, um Designobjekte in einem Designdokument zu ändern oder zu bearbeiten. Eine Script Form hostet Steuerelemente als Benutzeroberfläche und nutzt die X2 API, um Skriptdialoge bereitzustellen, die auf aktive Designdokumente wirken.
• Eine Script Form ist eine visuelle Formulareinheit, die vom Skript unterstützt wird. Wenn ein Formular aktiv ist, stellt es ein Dialogfenster dar.
• Eine Script Form hat zwei Ansichten – die Ansicht „Script Code“ und die Ansicht „Script Form“. Die Ansicht „Script Code“ enthält Event-Handler sowie Prozeduren/Funktionen. Die Ansicht „Script Form“ stellt ein Dialogformular (verschiedener Typen) dar und enthält Steuerelemente zusammen mit den zugehörigen Event-Handlern.
• Eine Script Form hat zwei zugehörige Dateien. Eine *.pas-Datei enthält Event-Handler und Prozeduren/Funktionen, und eine *.dfm-Datei enthält Details zur Script Form selbst sowie zu ihren Komponenten und deren Positionen.
• Eine Komponente ist ein visuelles oder nicht visuelles Steuerelementobjekt (platziert aus dem Tool Palette panel), das Eingaben eines Benutzers akzeptiert, etwa einen Mausklick oder eine Folge eingegebener Zeichen. Während des Designs kann das Object Inspector panel verwendet werden, um Komponenten auf einer Script Form zu bearbeiten. Die Komponenten können in jeder Script Form in jedem vom Skriptsystem unterstützten Sprachsatz verwendet werden.
• Eine Komponente (Steuerelementobjekt) verfügt über Methoden, Eigenschaften und Ereignisse, die von einer Script Form verwendet werden können.
  • Methoden sind die Aktionen, die ein Objekt ausführen kann.
  • Eigenschaften stellen die im Objekt enthaltenen Daten dar, auf die zugegriffen oder die geändert werden können.
  • Ereignisse sind Bedingungen, auf die eine Komponente in einer Script Form reagieren kann.
• Eine Script Form verfügt über Event-Handler, die erfasste Bedingungen verarbeiten, beispielsweise wenn auf eine Formularschaltfläche geklickt wird.

Altium Designer-Skriptbeispiele

Beispiel- und Referenzskripte sind eine hilfreiche Ressource, um zu verstehen, wie Objektschnittstellen, Methoden, Prozesse, Eigenschaften und Komponenten in Skripten angewendet werden. Sie können auch als Grundlage für Ihre eigenen Skriptprojekte verwendet werden.

Ausführen eines Beispiels

Um ein Skriptbeispiel in Altium Designer schnell auszuführen, öffnen Sie zunächst ein Beispielprojekt oder eine einzelne Skriptdatei aus einem der Beispielskriptordner – zum Beispiel das einfache Projekt „Hello World“ (HelloWorld.PRJSCR) aus dem Ordner Scripts\Delphiscript Scripts\General.

Das DelphiScript-„Hello World“-Projekt ist im Projects Panel geöffnet.

Das Projekt enthält zwei Versionen des Skripts „Hello World“, wobei die zweite (HelloWorlDialog.pas) die grundlegende Verwendung einer Form-Einheit demonstriert. Doppelklicken Sie auf einen Skriptnamen, um das Skript im Editor zu öffnen und zu prüfen – beachten Sie, dass ein Skript ausgeführt werden kann, ohne im Editor geöffnet zu sein.

Um eines der Skripte auszuführen, wählen Sie File » Run Script in den Hauptmenüs und wählen dann eine verfügbare Skriptprozedur im Dialog Select Item To Run aus. Wenn eine Version ausgeführt wird, wird ein Dialog geöffnet, um die Meldung anzuzeigen.

Die schnelle und einfache Methode, ein Beispielskript auszuführen.

Einrichtung des Skriptsystems

Voreinstellungen

Die Standard-Voreinstellungen für das Skriptsystem können im Dialog Preferences konfiguriert werden, der durch Klicken auf die Schaltfläche oben rechts im Designbereich aufgerufen wird.

Allgemeine Voreinstellungen

Auf der Seite Text Editors – General des Dialogs Preferences können Sie Ihre Anforderungen an die Skriptbearbeitung einrichten, z. B. das Verhalten bei der Zeichenfolgensuche, wie Zeilen mit Tabulatoren versehen und eingerückt werden, wie Tasten zugeordnet sind und eine Reihe weiterer erweiterter Optionen.

Die Seite Text Editors – General des Dialogs Preferences

Farbvoreinstellungen

Auf der Seite Text Editors – Colors des Preferences Dialogs können Sie die Syntaxhervorhebung des Script Editors für die Skriptsprache Ihrer Wahl konfigurieren und die Farbe der Elemente innerhalb des Skripteditors festlegen. Zum Beispiel Schwarz für den Hintergrund, Weiß für die Kommentar-Schlüsselwörter usw.

Die Seite Text Editors – Colors des Dialogs Preferences

Anzeigevoreinstellungen

Auf der Seite Text Editors – Display des Preferences Dialogs können Sie die visuellen Merkmale von Skripten konfigurieren, etwa die Anzeige rechter Ränder und von Zeilennummern, Syntaxhervorhebung und Code-Gliederung.

Die Seite Text Editors – Display des Dialogs Preferences

Globale Projektvoreinstellungen

Auf der Seite Scripting System – Global Projects des Preferences Dialogs werden verfügbare (installierte) Skriptprojekte aufgelistet. Skriptprojekte können installiert, entfernt oder neu angeordnet werden.

Die Scripting System – Global Projects Seite des Dialogs Preferences

Voreinstellungen für den Form Designer

Auf der Seite Scripting System – Form Designer des Preferences Dialogs stehen die Raster- und Komponentendesignator-Optionen für ein Skriptformular-Dokument zur Verfügung.

Die Scripting System – Form Designer Seite des Preferences Dialogs