スクリプトの作成と保存

Altium Designer のスクリプトは通常、スクリプトプロジェクト（*.PrjScr）で作成・保存されますが、どの種類のプロジェクトにも追加したり保存したりできます。

スクリプトの作成を始めるには、まず新しいスクリプトプロジェクトを作成し、そのプロジェクトにスクリプトファイルを追加します。

スクリプトプロジェクトとスクリプトの作成

スクリプトプロジェクトはスクリプトの管理に役立ち、メインメニューから File » New » Script » Script Project を選択して作成できます。

スクリプトを保存する新しいプロジェクト（Script_Project1.PrjScr）が、Projects パネルに一覧表示されます。

プロジェクトに新しいスクリプトを追加するには、プロジェクト名を右クリックし、コンテキストメニューから Add New to Project を選択します。

新しいスクリプトプロジェクトを作成したら、そのプロジェクトに新しいスクリプトを追加します。

新しいスクリプトを作成する際は、プロジェクト要件に応じて 2 種類のスクリプトタイプ（スクリプトユニットとスクリプトフォーム）から選択できます。

スクリプトタイプ

スクリプトユニット

スクリプトユニットは、DelphiScript などの特定の言語構文を持つスクリプトドキュメントです。

スクリプトコードを含むスクリプトユニット。

スクリプトフォーム

スクリプトフォームは、ボタン、メモ、リストボックスなどの各種コントロールを配置でき、イベントハンドラも持てるウィンドウです。エディタでは、スクリプトフォームには Code タブと Form タブで切り替え可能な 2 つのビューがあり、以下に示すスクリプトドキュメントの下部で確認できます。

Code タブと Form タブを開いたスクリプトフォーム。

プロジェクト内のスクリプト間の関係

プロジェクト内に複数のスクリプトがある場合、そのプロジェクト内の任意のスクリプト（同一の言語セットを使用しているもの）は、グローバル変数およびプロシージャにアクセスできます。実質的にプロジェクト内のすべてのスクリプトが「可視」になるため、あるスクリプト内のプロシージャから、同じスクリプトプロジェクト内の別スクリプトにある別のプロシージャを呼び出せます。

同一プロジェクト内のスクリプトでは、プロシージャ名とグローバル変数名を一意にすることが重要です。1 つの方法として、複数のスクリプトで使用する共通のプロシージャ／関数を、同一プロジェクト内の新しいスクリプト 1 つにまとめます。これにより、この新しい共通スクリプト内のプロシージャや関数を、別のスクリプトプロジェクトでも容易に再利用できます。

► 別スクリプトのプロシージャを呼び出す例については Writing Scripts を参照してください。

接続されたワークスペースへのスクリプトプロジェクトのアップロード

Altium Designer は、接続された Workspace と連携して、Workspace スクリプトを作成・管理できるようになっています。これらのスクリプトは Workspace 内で直接作成され、該当するスクリプトプロジェクト（*.PrjScr）が、対象の Workspace Scripts のリビジョンへアップロードされます。手順は次のとおりです。

1. Explorer パネルを使用して、接続された Workspace に新しい Script Item を作成します。Workspace での Item 作成については、Creating & Editing Content ページを参照してください。

2. Explorer パネルで必要な Script Item を右クリックし、コンテキストメニューから Upload コマンドを選択します。標準の Windows Open ダイアログが表示されるので、必要なスクリプトプロジェクトファイル（*.PrjScr）を参照して選択します。

   Item に計画済みリビジョンがない場合、アップロードは次の計画済みリビジョンに対して行われ、アップロード処理の一部としてその場で作成されます。

   
   対象の Script Item にアップロードするスクリプトプロジェクトファイルを指定します。

3. 目的のファイルを選択したら、Open ボタンをクリックしてアップロードを実行します。プロジェクトファイルは同じフォルダ内のすべてのファイルとともにリビジョンへアップロードされ、そのリビジョンの Details アスペクトビュータブ上で、Explorer パネルから利用できるようになります。

   
   アップロードされたプロジェクトは、同じフォルダ内のすべてのファイルとともに、Script Item のリビジョンに対する Details アスペクトビュータブに一覧表示されます。

別の方法として、Windows Explorer のソースフォルダから、選択したスクリプトプロジェクトファイルと関連ソースファイルをドラッグし、Explorer パネル内の目的のフォルダへドロップすることで、新しい Workspace Script にスクリプトプロジェクトをアップロードできます。Create New Item ダイアログが表示され、ドラッグしたファイルが Sources 領域に一覧表示されます。Item の Name は拡張子を含むファイル名となり（エントリはセミコロンで区切られます）、Description は Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate> 形式になります（エントリはセミコロンで区切られます）。必要に応じてこれらを変更してください。Item ID はフォルダレベルで定義された Item Naming スキームに従います。フォルダに命名スキームが定義されていない場合、命名は $CONTENT_TYPE_CODE-{000000} スキームに従います。

ドラッグ＆ドロップ方式を使用して、新規作成した Workspace Script の初期リビジョンへスクリプトプロジェクトと関連ファイルをアップロードします。

Workspace スクリプトの編集

いつでも、Workspace スクリプトの任意のリビジョンに戻って直接編集できます。Explorer パネルでそのリビジョンを右クリックし、コンテキストメニューから Edit コマンドを選択します。これにより、そのリビジョンが Altium Designer で開かれ、必要に応じて編集した後、Save to server コマンド（ショートカット：Ctrl+Alt+S）を使用して次のリビジョンとして Workspace に保存できます。これは Projects パネル内のプロジェクトエントリに関連付けられた右クリックのコンテキストメニューから利用できます。

既存リビジョンのスクリプトを直接編集するためのコマンドにアクセスします。

Workspace スクリプトに保存されているプロジェクトまたは関連ソースを変更する必要があり、更新済みのソースファイルがある場合は、それらのファイルをその Workspace スクリプトにアップロードできます。新しいファイルは、その Workspace スクリプトの次のリビジョンに保存されます。

グローバルプロジェクト

スクリプトプロジェクトは Global Projects 機能を使用してインストールでき、ソフトウェア起動時に事前ロードされて利用可能になります。これらのスクリプトのグローバル変数およびプロシージャは、他の開いているスクリプトプロジェクトから使用できます。

スクリプトプロジェクトをグローバルにするには、Preferences ダイアログから Scripting System - Global Projects ページへ移動します。Install ボタンを使用して、ファイルまたは Workspace からプロジェクトを参照して選択します。グローバルに利用可能にしたいすべてのスクリプトプロジェクトについて、この手順を繰り返します。

インストールされた Workspace Script プロジェクトは、ユーザーが Workspace に接続している間は常に Altium Designer で利用できます。なお、インストールされた Workspace Script プロジェクトは、Workspace のフォルダ構造内での場所（または「パス」）と、スクリプトプロジェクトデータを含む Workspace Script の ID によって一覧表示されます。

Preferences ダイアログの Scripting System – Global Projects を使用してスクリプトをインストールします。

グローバルプロジェクトにより、同じ種類のローカルプロジェクトのスクリプトが、インストール済みのグローバルスクリプトプロジェクトのルーチンを使用できるようになります。Select item to Run ダイアログ（File » Run Script）を起動すると、インストール済みのスクリプトプロジェクトが、現在開いている他のスクリプトプロジェクトとともに Projects パネルに表示されます。