グラフィカル・コンポーネントのスクリプティング

概略

VCLベースのコントロールからAltium固有のコンポーネントまで、Altium Designerのスクリプトで利用できるグラフィカルコンポーネントをご紹介します。このリファレンスでは、Script Formの作成方法、コンポーネントのプロパティ、メソッド、イベントの確認方法、およびTool PaletteパネルとObject Inspectorパネルを使用してフォームの外観や動作をカスタマイズする方法を説明します。スクリプトフォームとそのコントロールを自信を持って扱えるよう、ぜひ読み進めてください。

- Script Formを作成し、Tool Paletteパネルからコントロールを追加する方法を学びます。
- プロパティの確認、メソッドの検索、ユーザー操作に対応するイベントハンドラーの生成方法を紹介します。
- フォームの外観、ウィンドウの動作、キーボード入力、初期フォーカスを制御する設定を理解します。
AIでさらに深掘り:
 

このリファレンスでは、スクリプトでサポートされているグラフィカルコンポーネントと、その主なプロパティおよびメソッドについて説明します。

Altium Designerのスクリプトで使用できるビジュアルフォームコンポーネントの大部分は、EmbarcaderoのVisual Component Library(VCL)から派生しています。VCLは、DelphiおよびC++言語を使用してWindowsアプリケーションを開発するための、定義済みビジュアルコンポーネントのコレクションです。

ビジュアルクラスライブラリとして開発されたVCLのクラスは、直線的なオブジェクト階層でTComponentオブジェクト(それ自体はルートオブジェクトであるTObjectから派生)を継承しています。そのため、TButtonオブジェクトなどの一般的なスクリプトコンポーネントは、上位オブジェクトのプロパティ、メソッド、イベントを継承します。この場合のクラス階層は、TObject → TPersistent → TComponent → TControl → TWinControl → TButtonControl → TButtonです。

TControlオブジェクトから派生するコンポーネントは通常ビジュアルコンポーネント(コントロール)であり、TWinControlから派生する一般的なコンポーネントは主にWindows APIのラッパーであることに注意してください。

► VCLのアーキテクチャとコンポーネントの概要については、Embarcadero RAD Studio VCLを参照してください。

Altium Designerのスクリプトエディターでフォームを作成する際は、Tool Paletteパネルからコンポーネントにアクセスします。スクリプトフォームには、フォームの設定、コンポーネントの位置、その他の属性の詳細を含む*.DFMファイルが関連付けられています。このファイルは、スクリプトプロジェクトの保存先フォルダーにあります。Altium Designerでは、スクリプトフォームの設計時に、DelphiScriptまたはVBScriptのいずれからでもコンポーネントを使用できます。

VBScript言語はレガシーと見なされており、デフォルトでは使用できませんが、詳細設定のLegacy.Scripts.SupportOldLanguages設定で有効にできます。

Tool Paletteパネルには、スクリプトフォームにドラッグ&ドロップできるビジュアルコントロールが、カテゴリ別に表示されます。
Tool Paletteパネルには、スクリプトフォームにドラッグ&ドロップできるビジュアルコントロールが、カテゴリ別に表示されます。

Tool Paletteパネルには、スクリプトフォームに配置できるコンポーネントがカテゴリ別に表示されます。使用可能なコンポーネントは、Tool Paletteパネル内の展開可能なセクションにまとめられており、Standard、Additional、Win32、System、Dialogs、Altium Standard、Instrument Controlsに分類されています。

パネルの表示と動作は、右クリックのコンテキストメニューから変更できます。

パレットで使用できるコンポーネント(または「コントロール」)は、スクリプトフォーム上で使用するとビジュアルコンポーネントになります。つまり、ユーザーは実行時にコントロールを確認でき、操作できる場合もあります。すべてのコントロールには、外観や動作を規定するプロパティ、メソッド、イベントがあります。たとえば、コントロールの位置を指定するプロパティ、コントロールを描画または移動するメソッド、ユーザーの操作に応答するイベントなどです。

現在選択されているフォームコンポーネント(フォーム自体を含む)のプロパティとイベントは、Object Inspectorパネルで確認できます。メソッドは、そのコンポーネントでサポートされているプロシージャと関数です。

スクリプトフォームの概要

スクリプトフォーム

スクリプトフォームは、スクリプトの主要なユーザーインターフェースです。ただし、ダイアログボックスやセカンダリウィンドウなど、ほかの形式もあります。新しいスクリプトフォームを作成するには、Altium Designerでプロジェクトを開いた状態でFile » New » Script » Script Formを選択するか、スクリプトプロジェクト名を右クリックしてAdd New to Project » Script Formを選択します。VBScript言語が有効になっている場合、このコマンドはVB ScriptとDelphi Scriptの両方で使用できます。

新しいスクリプトフォームは、デフォルトのフォーム名Form1で表示されます。この名前は、Object InspectorパネルのMiscにあるNameプロパティで変更できます。スクリプトフォーム名は、プロジェクト内で一意である必要があります。

スクリプトフォームを設計する際は、下部のステータスバーにあるScript ボタンからObject Inspectorパネルを開きます。スクリプトフォームを設計する際は、下部のステータスバーにあるScript ボタンからObject Inspectorパネルを開きます。

空のフォームは、基本的にはコントロールを追加できるビジュアルウィンドウです。ダイアログとパネルは異なる種類のフォームであり、フォームにはデフォルトで次のような標準的なウィンドウ機能が備わっています。

  • コントロール
  • 最小化ボタンと最大化ボタン
  • タイトルバー
  • 境界線のドラッグによるサイズ変更

これらの機能や、使用可能なその他のフォームプロパティは、設計時にObject Inspectorパネルで変更できます。スクリプトフォームはVCLコンポーネントであるため、次の3つの要素を持ちます。

  • Properties – オブジェクトの視覚的な振る舞いや動作に影響する特性です。たとえば、Visible プロパティは、スクリプトフォーム上でオブジェクトを表示するかどうかを決定します。
  • Events – スクリプトによって検出される操作や事象です。スクリプトには、マウスクリックなどの特定のイベントを捕捉するための各イベントハンドラーのコードを含める必要があります。
  • Methods – オブジェクト(ここではコンポーネントオブジェクト)に関連付けられ、その動作を定義するスクリプトのプロシージャです。

► フォームベースのスクリプト開発に関する基本ガイドについては、スクリプトの作成を参照してください。

フォームのプロパティ、メソッド、イベント

Tool Paletteパネルのコントロールは、EmbarcaderoのVisual Component Library(VCL)をベースにしています。Formコンポーネント(TForm)のメソッド、プロパティ、イベントの詳細については、EmbarcaderoのVCLドキュメントを参照してください。

► Embarcadero TFormリファレンスを参照してください。

上記のリンクは、VCLライブラリのEmbarcadero RAD Studio XE6リファレンスを参照していることに注意してください。過去のリリース(2010バージョンまで)のドキュメントも利用できます。

TFormのプロパティ

基本となるスクリプトフォームであるTFormコンポーネントオブジェクトで使用可能なプロパティは、次の方法で確認できます。

  • Object Inspectorパネルで確認する – エディターのフォームビュー(Form タブを選択)で、フォーム自体の内側をクリックし、Object Inspector's Properties タブを選択します。

パネルに表示されるのは、ビジュアルコンポーネントオブジェクトのみであることに注意してください。バックグラウンドで制御を行う非ビジュアルオブジェクトは、フォーム上には表示されません。

  • コード補完機能を使用する – エディターのコードビュー(Code タブを選択)では、コンテキストに応じたコード補完ウィンドウに、オブジェクト名に対して使用可能なすべてのコード候補が表示されます。

Formオブジェクトの場合は、TForm.(ピリオドに注意)を入力してウィンドウを表示します。目的のプロパティの先頭数文字を入力して、候補を絞り込みます。プロパティとメソッドの両方が表示されることに注意してください。

TFormのメソッド

TFormコンポーネントオブジェクトで使用可能なメソッドは、次の方法で確認できます。

  • コード補完機能を使用する – エディターのコードビューで、コンポーネント名に続けてピリオドを入力します。コード補完ウィンドウが開き、オブジェクト名に対応するコードのメソッド(およびプロパティ)が表示されます。このウィンドウは、Crtl+Spaceショートカットキーで手動で表示することもできます。

TFormのイベント

TFormコンポーネントオブジェクトで使用可能なイベントは、次の方法で確認できます。

  • Object Inspectorパネル – エディターのフォームビューで、フォーム自体の内側をクリックし、Object InspectorのEvents タブを選択します。

コンポーネントのプロパティ、イベント、メソッド

Tool Paletteパネルのコントロールは、Embarcadero Visual Component Library(VCL)に基づいています。大半のコンポーネントのメソッド、プロパティ、イベントの詳細については、Embarcadero VCLドキュメントのコンポーネントカテゴリを参照してください。Tool Palette内の一部のコンポーネントタイプ、特にAltium Instrument Controlsは、Altium Designer独自のものであり、Embarcaderoのリファレンスドキュメントには含まれていません。

► Embarcadero VCLコンポーネントカテゴリ索引

を参照してください。 上記のリンクは、Embarcadero RAD Studio XE6のVCLライブラリリファレンスを参照しています。以前のリリース(2010バージョンまで)のドキュメントも利用できます。

コンポーネントのプロパティ

コンポーネントのプロパティ一覧を表示するには、次の操作を行います。

  • フォーム上のコンポーネントを選択し、Object InspectorパネルのPropertiesタブをアクティブにします。上図では、TFormコンポーネントオブジェクトの例を示しています。
  • Embarcaderoリファレンスドキュメントで、該当するコンポーネントのリファレンスページの上部にある「プロパティ」リンクを選択します。たとえば、TButtonコントロールの場合は、標準コンポーネントカテゴリ、TButtonページ、プロパティビューの順に選択します。

コンポーネントのイベント

コンポーネントが応答できるイベントの一覧を表示するには、次の操作を行います。

  • フォーム上のコンポーネントを選択し、Object InspectorパネルのEvents タブをアクティブにします。上図では、TFormコンポーネントオブジェクトの例を示しています。
  • Embarcaderoリファレンスドキュメントで、該当するコンポーネントのリファレンスページを選択し、その「イベント」リンクを選択します。これはコンポーネントで利用可能なイベントを確認するための目安として役立ちますが、Altium Designerのスクリプトコンポーネントで利用可能なイベントとは完全に一致しない場合があります。

イベント処理プロシージャを作成するには、Object Inspector Eventsタブでコンポーネントが応答するイベントを選択し、イベントの入力フィールドをダブルクリックします。コンポーネント名とイベントの動作に基づく名前のイベントハンドラープロシージャが、スクリプト内に自動生成されます。Object Inspectorパネルでイベント名を変更すると、対応するコード内のプロシージャ名もそれに合わせて変更されます。

コンポーネントのメソッド

Tool Paletteコンポーネントで利用可能なメソッドについては、コンポーネントカテゴリのドキュメントを参照してください。

これには、次のコントロールオブジェクトカテゴリのリファレンスが含まれます。

  • 標準
  • 追加
  • Win32
  • システム
  • ダイアログ
  • Altium標準
  • 計測器コントロール

これらのカテゴリは、主に標準のDelphiタイプのVCLコンポーネントに基づくビジュアルフォームコントロールを種類別にまとめたものです。ただし、「Altium標準」と「計測器コントロール」のカテゴリは例外で、Altium Designerのスクリプトシステム独自のコンポーネントを提供しています。

► Tool Palette コンポーネントカテゴリを参照してください。

フォームとコンポーネントの操作

スクリプトフォームのカスタマイズ

  • たとえば、開いている他のパネルよりも常にフォームを手前に表示するには、FormStyleプロパティをfsStayOnTopに設定します。
  • フォームのデフォルトの動作を定義するには、FormKindを次のいずれかの値に設定します。fkNone, fkNormal, fkServerPanelまたはfkModal。
    • fkModalを選択すると、フォームはモーダルフォームになります。つまり、フォームを閉じるなどの操作を続行する前に、ユーザーの入力を待つフォームになります。
    • fkServerPanelを選択すると、フォームはサーバーパネルとして表示されます。
    • fkNormalを選択すると、フォームは通常のモードレスフォームとして動作します。
  • フォームのスクロールバーを追加または削除するには、HorzScrollBarプロパティとVertScrollBarプロパティの値を変更します。
  • フォームをMDI(マルチドキュメントインターフェース)のフレームまたは子ウィンドウにするには、FormStyleプロパティを使用します。
  • フォームの境界線スタイルを変更するには、BorderIconsプロパティとBorderStyleプロパティを使用します。(結果は実行時に確認できます。)
  • 最小化されたフォームのアイコンを変更するには、Iconプロパティを使用します。
  • アプリケーションウィンドウ内でのフォームの初期位置を指定するには、Positionプロパティを使用します。
  • フォームの初期状態(最小化、最大化、通常など)を指定するには、WindowStateプロパティを使用します。
  • 実行時のフォームの作業領域を定義するには、ClientHeightプロパティとClientWidthプロパティを使用します。ClientHeightとClientWidthはフォームの境界線の内側の領域を表し、HeightとWidthはフォーム全体の領域を表します。
  • 実行時にフォーム内で最初にフォーカスを受け取るコントロールを指定するには、ActiveControlプロパティを使用して、利用可能なコンポーネントから選択します。
  • 選択されているコントロールに関係なく、すべてのキーボードイベントをフォームに渡すには、KeyPreviewプロパティを使用します。
  • フォームに複数のメニューが含まれる場合に、特定のメニューを指定するには、Menuプロパティを使用します。

フォームとコンポーネントの再描画

スクリプトフォームの表示が最新の状態に更新されなくなる場合があります。たとえば、スクリプトによる負荷の高いバックグラウンド処理によってコントロールの更新や再描画が行われず、表示がフリーズしたり乱れたりすることがあります。

スクリプトフォームのUpdateメソッドを使用すると、フォームや特定のコントロールの表示内容をプログラムで再描画できます。以下のコード例では、Updateメソッドのコード行が灰色で強調表示されています。

Using the Update method to refresh the Status Bar:

Procedure TConverterForm.loadbuttonClick(Sender: TObject);
Var
   I, J : Integer;
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
            For J := 0 to Image1.Picture.Height – 1 Do
                For I := 0 to Image1.Picture.Height – 1 Do
            Begin
                If Image1.Canvas.Pixels[I,J] <> clWhite Then
                    Image1.Canvas.Pixels[I,J] := clBlack;
            End;
        End;

        ScalingFactorChange(Nil);

        convertbutton.Enabled  := True;
        LoadButton.Enabled     := False;
        XStatusBar1.SimpleText := '  Ready...';
        XStatusBar1.Update;
    End;
End;

ダウンロード可能なスクリプト集のScripts\Delphiscript Scripts\PCB\PCB Logo CreatorフォルダーにあるPCB Logo Creatorスクリプトプロジェクトを参照してください。

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Nav
Contents
機能の提供状況

ご利用可能な機能は、お使いのAltiumソリューション(Altium Develop、Altium Agile Teams、Altium Agile Enterprise、または有効な契約期間中のAltium Designer)によって異なります。

実際にお使いのソフトウェアに文書化されている機能が表示されない場合は、詳細についてAltium Sales までお問い合わせください。

従来のドキュメント

Altium Designer のドキュメントは、バージョンごとに掲載されなくなりました。Altium Designer の旧バージョンのドキュメントは、Other Installers ページの Legacy Documentation の項目をご覧ください。

Contents