Altium Designerにおけるスクリプティングシステムの概要と設定

Altium Designerのスクリプティングシステムは、ソフトウェア内のタスクを自動化するスクリプトを作成するために必要なすべてのツールと機能を提供します。

スクリプトエディタ、デバッガ、およびスクリプティングパネルが連携して、スクリプトの作成とデバッグを簡単に行うことができます。スクリプトはスクリプトエディタから直接実行することも、メニュー、ツールバー、またはホットキーに割り当てて、いつでも現在のドキュメント（例えばPCBレイアウト）に適用することもできます。

Altium Designer でスクリプトコードとフォームウィンドウが表示され、オブジェクトインスペクター、コードエクスプローラー、ツールパレットパネルがあります。

スクリプティングシステムの特徴

スクリプティングシステムは、エディタとデバッガの2つの主要な部分で構成されています。主な特徴は以下の通りです：

• プロジェクトアクセス - スクリプトは、スクリプトプロジェクトまたはデザインプロジェクトに保存できます。プロジェクト内の任意のスクリプトからのルーチンは、同じプロジェクト内の他のスクリプトからアクセス可能です。

• スクリプティングエディタ - スクリプティングエディタには、編集環境の設定と構文の色分けを行うためのオプションが豊富に備わった専用のテキストエディタが搭載されています。

• スクリプティングパネル - スクリプティングシステムには、スクリプトのコーディングとデバッグを迅速に行うための多数のパネルが用意されています。

• スクリプティングデバッガ - スクリプトの実行時にエラーが発生した場合、簡潔なエラーメッセージが表示されるダイアログが現れます。ウォッチウィンドウで変数をプレビューしたり、コードをトレースしたり、スクリプトの実行を制御することができます。

• スクリプティング言語 - スクリプトはDelphiScriptで作成でき、レガシー言語として有効にされている場合はVBScriptでも作成できます。

スクリプトユニットとフォーム

スクリプトプロジェクトは、スクリプトユニットとスクリプトフォームの2種類のスクリプトドキュメントタイプをサポートしています。スクリプトユニットでは、スタンドアロンの手続きや関数を記述できます。スクリプトフォームでは、コントロールとイベントハンドラを備えたダイアログの構築、および手続きや関数を作成できます。

• スクリプトフォームは、スクリプトによってサポートされる視覚的なフォーム単位です。フォームがアクティブなとき、それはダイアログウィンドウを表します。
• スクリプトフォームには2つのビューがあります – スクリプトコードビューとスクリプトフォームビューです。スクリプトコードビューにはイベントハンドラと手続き/関数が含まれています。スクリプトフォームビューは、異なるタイプのダイアログフォームを表し、それに関連するイベントハンドラと共にコントロールを持っています。
• スクリプトフォームには2つの関連ファイルがあります。*.pas ファイルにはイベントハンドラと手続き/関数が含まれ、*.dfm ファイルにはスクリプトフォーム自体の詳細とそのコンポーネント及びその位置が含まれています。
• コンポーネントは、ユーザーからの入力（マウスクリックや入力された文字列など）を受け入れる視覚的または非視覚的なコントロールオブジェクト（Tool Paletteパネルから配置される）です。設計中には、Object Inspectorパネルを使用してスクリプトフォーム上のコンポーネントを操作できます。これらのコンポーネントは、スクリプトシステムがサポートする任意の言語セットの任意のスクリプトフォームで使用できます。
• コンポーネント（コントロールオブジェクト）には、スクリプトフォームで使用できるメソッド、プロパティ、イベントがあります。
  • メソッドはオブジェクトが実行できるアクションです。
  • プロパティはオブジェクトに含まれるデータを表し、アクセスまたは変更できます。
  • イベントはスクリプトフォーム上のコンポーネントが反応できる条件です。
• スクリプトフォームには、フォームボタンがクリックされたときなど、キャプチャされた条件を処理するイベントハンドラがあります。

スクリプトのドキュメントは主にDelphiScript言語セットに焦点を当てています。DelphiScript言語セットは、Embarcadero DelphiScript技術に基づいています。DelphiScriptとObject Pascal（Delphiで使用される）の違いについては、DelphiScript参照ドキュメントを参照してください。

Altium Designer スクリプト例

オブジェクトインターフェース、メソッド、プロセス、プロパティ、コンポーネントがスクリプトでどのように適用されるかを理解するための例と参照スクリプトは、役立つリソースです。これらは、独自のスクリプトプロジェクトの基礎としても使用できます。

例の実行

Altium Designerでスクリプト例をすぐに実行するには、まず例のプロジェクトまたは例のスクリプトフォルダーの中の個々のスクリプトファイルを開きます。例えば、Scripts\Delphiscript Scripts\Generalフォルダーからのシンプルな「Hello World」プロジェクト（HelloWorld.PRJSCR）などです。

DelphiScriptのHello Worldプロジェクトがプロジェクトパネルで開かれています。

このプロジェクトには、「Hello World」スクリプトの2つのバージョンが含まれており、2番目のバージョン（HelloWorlDialog.pas）では、フォームユニットの基本的な使用方法を示しています。スクリプト名をダブルクリックすると、エディタでスクリプトを開いて検査できます。なお、エディタで開かれていないスクリプトも実行することができます。

スクリプトを実行するには、メインメニューからFile » Run Scriptを選択し、実行するアイテムを選択ダイアログから利用可能なスクリプト手順を選択します。バージョンを実行すると、メッセージを表示するダイアログが開きます。

例のスクリプトを簡単に実行する方法。

スクリプティングシステムのセットアップ

設定

スクリプトシステムのデフォルト設定は、ワークスペースの右上にある コントロールボタンをクリックしてアクセスされるPreferencesダイアログで構成できます。

一般設定

PreferencesダイアログのText Editors – Generalページでは、文字列検索の動作、行のタブやインデントの方法、キーのマッピング方法など、スクリプト編集の要件を設定できます。また、その他の高度なオプションも多数設定できます。 PreferencesダイアログのText Editors – Generalページ

色の設定

PreferencesダイアログのText Editors – Colorsページでは、選択したスクリプト言語のスクリプトエディターの構文色を設定し、スクリプトエディター内の要素の色を設定できます。例えば、背景を黒、コメントキーワードを白などに設定できます。

PreferencesダイアログのText Editors – Colorsページ

表示設定

PreferencesdダイアログのText Editors – Displayページでは、スクリプトの視覚的特徴を設定できます。これには、右マージンと行番号の表示、構文のハイライト、コードのアウトラインなどが含まれます。

PreferencesdダイアログのText Editors – Displayページ

グローバルプロジェクトの設定

PreferencesダイアログのScripting System – Global Projectsページでは、利用可能（インストールされている）スクリプトプロジェクトをリストアップします。スクリプトプロジェクトは、インストール、削除、または並べ替えが可能です。

PreferencesダイアログのScripting System – Global Projectsページ

フォームデザイナーの設定

PreferencesダイアログのScripting System – Form Designerページではスクリプティングフォームドキュメントのグリッドとコンポーネント指定オプションを提供します。

PreferencesダイアログのScripting System – Form Designerページ