このドキュメントは、Altium Designer SDK の一部である Altium Designer の低レベル System API に関するリファレンスを提供します。

本書には、Altium Designer におけるサーバー開発に使用できる低レベルのアプリケーション・プログラミング・インターフェース情報が含まれています。Altium Designer SDK は、必要に応じてサーバープロジェクト内の Source Units を Uses 句に追加して構成されます。

Altium Designer System API のオブジェクトインターフェース

Altium Designer SDK

Plug-in SDK は、プラグインやアドオンの開発において Altium Designer API の全機能を活用できます。 スクリプトシステムは Altium Designer SDK のサブセットを実装しています。基本的に、スクリプトシステムで使用される Altium Designer のオブジェクトインターフェースは、プラグインプロジェクトでも利用できます。

システムレベル - Electronic Design Platform API

• Altium Designer スイート内の Electronic Design Platform のさまざまなオブジェクトを扱うクライアント/サーバーインターフェース。
• プラグインのプロセスを扱うルーチン
• Altium Designer プラットフォームの低レベル実装を扱うルーチン
• Embarcadergo Delphi のソースユニットから公開されるルーチンおよびオブジェクト。

他の API 用の個別リファレンス

• Schematic API（EDPXXX_SCH ファイル群）については Schematic API Reference
• を参照してください PCB API（EDPXXX_PCB ファイル群）については PCB API Reference
• を参照してください Integrated Library API（EDPXXX ファイル群）については Integrated Library API Reference
• を参照してください Workspace Manager および Integrated Library API（EDPXXX ファイル群）については Workspace Manager API Reference
• を参照してください Client Server API（EDPXXX ファイル群） 。

インターフェースとは何か?

インターフェース内の各メソッドは、対応するクラスで実装されます。インターフェースはクラスのように宣言されますが、直接インスタンス化することはできず、独自のメソッド定義も持ちません。クラスがサポートする各インターフェースは、実際にはメソッドへのポインタのリストです。したがって、インターフェースに対してメソッド呼び出しが行われるたびに、その呼び出しは実際にはインターフェースが保持するメソッドポインタの 1 つへ振り分けられ、本当にそれを実装しているオブジェクトが処理を行えるようになります。
クライアント/サーバーインターフェースは、関連するオブジェクトがメモリ上に存在する限り存在します。そのため、プラグインプロジェクトでコードを書く際には、問い合わせようとしているインターフェースが存在するかどうかを、そのメソッドを呼び出す前に確認する責任があります。

空のワークスペース、つまり Altium Designer のシェルは最上位のクライアントウィンドウです。クライアントモジュールは IClient インターフェースオブジェクトで表され、この IClient インターフェースを通じて、読み込まれたサーバーのデータ構造を参照できます。プラグインは IServerModule インターフェースとして表され、Altium Designer 内のプラグインモジュールとなります。

Client 関数を呼び出すことで IClient インターフェースオブジェクトを取得でき、その後、このオブジェクトから直接メソッドを実行できます。たとえばこの Client.OpenDocument('Text',FileName); を呼び出します。

Example

Var
  ReportDocument  :  IServerDocument;
Begin
  If  Client  =  Nil  Then  Exit;
  //  Opens  and  shows  a  text  file  in  Altium  Designer
  ReportDocument  :=  Client.OpenDocument('Text',FileName);
  If  ReportDocument  <>  Nil  Then
  Client.ShowDocument(ReportDocument);
End;

スクリプト例
\Client / Server スクリプトの例は \Examples\Scripts\DXP フォルダーにあります

Client / Server インターフェースの使用

Altium Designer のアーキテクチャの中心にあるのは、単一のクライアントモジュールがコントローラーとして機能し、ロードされたサーバーと連携するという概念です。各サーバーは自身のドキュメントを管理します。これが Altium Designer の全体像です。つまり、1 つの Client 実行ファイルと、下図に示すように動的リンクライブラリモジュールとしてロードされる複数のサーバーがあります。

オブジェクトインターフェース

IClient インターフェースは Altium Designer アプリケーションの Client サブシステムを表し、Client サブシステムは、ロードされたサーバーのコマンド（事前にパッケージ化されたプロセスランチャー）、プロセスの深さ、およびドキュメントを管理します。Altium Designer にロードされるすべてのサーバーモジュールは Altium Designer のクライアントサブシステムにリンクされているため、特定のロード済みドキュメントにアクセスできます。
クライアントモジュールはロード済みサーバーの一覧を保持しています。つまり、このモジュールは、開かれているサーバードキュメント、ロード済みサーバープロセス、ロード済みサーバーリソースの複数のリストを格納しています。
スクリプト内で Client 関数を呼び出すことで IClient インターフェースオブジェクトを取得し、この関数から直接メソッドを実行できます。たとえば Client.OpenDocument('Text',FileName); というメソッド呼び出しは有効です。
Client 関数は IClient インターフェースオブジェクトを返します。

Client のインターフェース

• ICommandLauncher（プロセスランチャーを扱う）
• IServerDocumentView（パネルまたはサーバードキュメントを扱う）
• IProcessControl（スタックされたプロセスのレベルを決定する）
• IGUIManager（ユーザーインターフェース、パネルの位置と状態を扱う）
• IServerModule（ロードされたサーバーを扱う）
• INotification（通知メッセージをサーバー群または指定したサーバーへブロードキャストまたはディスパッチする）

サーバーインターフェース

IServerModule インターフェースは、Altium Designer にロードされたサーバーを表します。サーバーモジュールを取得してそのメソッドを呼び出すには、ModuleName プロパティに対象サーバー名を渡して使用します。問題がなければ、そのサーバーのプロセスを起動できます。以下に例を示します。
Example

If  StringsEqual(ServerModule.ModuleName,'TextEdit')  Then
Begin
  ServerModule.CommandLauncher.LaunchCommand('TextEdit:MoveCursorToTopOfDocument',
    Nil,0,ServerDocument.View[0]);
End;

サーバーとそのドキュメントの関係

IServerModule インターフェースには、次のインターフェースがあります。
• ICommandLauncher（サーバーのプロセステーブルを扱う）
• IServerDocument（Altium Designer にロードされた設計ドキュメントを表す）
• IServerView（システムのビューを持つことができるパネルを表す）
• IServerDocumentView（ドキュメントビュー、つまりドキュメントウィンドウまたはパネルウィンドウを扱う）
• IExternalForm（ドキュメントフォームまたはパネルフォームとして認識される、Altium Designer 対応の Delphi フォームを表す。これらのフォームは IServerDocumentView または IServerView インターフェースオブジェクトによってラップされます。この IExternalForm インターフェースオブジェクトには、フォームのサイズ変更や表示などの低レベルメソッドがあります）
• IProcessControl（フォーカスされているサーバードキュメントに対するスタック済みプロセスのレベルを表す）
• INotification は Client システムからのシステム通知を表し、すべてのサーバーモジュールがこれらの通知を受け取ります。通知を処理し、それに応じた動作を行うことができます。また、通知を使用してドキュメントと関連パネルを同期させることもできます）。

Altium Designer におけるサーバーのドキュメントおよびパネルのインターフェース

ドキュメントとパネルの概念は、Altium Designer でサーバーがどのように動作するかを理解するうえで中心的です。サーバーは自身のパネルとドキュメントを管理します。Altium Designer は現在アクティブなパネルとドキュメントにアクセスでき、それらのサイズと位置を管理します。基本的に、パネルには 2 種類あります。ドキュメントに関連付けられたパネルと、Messages パネルのようなスタンドアロンパネルです。
Altium Designer にロードされた各サーバーは、それぞれ独自のドキュメントを格納します（たとえば PCB ドキュメントや PCB ライブラリドキュメントなど、異なるドキュメント種別があります）。また、各ドキュメントには対応するパネルがあります。たとえば PCB パネルと PCB ドキュメントです。さらに、サーバーは同じドキュメント種別を格納する独自のドキュメントコンテナを持ちます。そのため、異なるドキュメント種別ごとにドキュメントコンテナが存在します。各ドキュメントコンテナには、ドキュメントのビューと関連パネル、さらに存在する場合はスタンドアロンパネルも格納されます。
下のスクリーンショットでは、Altium Designer で 2 つの PCB ドキュメントが開かれており、左側に Projects パネルがあり、PCB ドキュメント上部にはフローティング PCB パネルが表示されています。アドオンのフローティングツールバーも表示されています。

ここでは、上図に示されている Altium Designer 内のサーバー、ドキュメント、およびパネルを表す主なインターフェースについて見ていきます。
Altium Designer 内の Client システムは、アクティブなドキュメントおよびパネルビューに直接アクセスできます。そのため、パネルの境界や表示/非表示は、IClient およびその複合 IClientGUIManager インターフェースを通じてプログラムから設定できます。Client と Server モジュールはそれぞれ独自の Command Launcher 機能を持ち、これはサーバープロセスの実行に使用されます。これは ICommandLauncher インターフェースとしてカプセル化されています。
Altium Designer の Work-space manager サーバーには、複数の IServerView インターフェースがあります。たとえば Files パネル、Projects パネル、Messages パネル、Navigator パネル、Errors パネル、Differences パネル、To Do パネルなどです。

主なインターフェースは 3 つあり、IServerModule、IServerView、IServerDocumentView インターフェースについて、上図に関連付けて見ていきます。

IServerModule Interface

Altium Designer にロードされる各サーバーは IServerModule インターフェースによってカプセル化されます。したがって、上図では PCB エディターサーバー用の IServerModule インターフェース、Work-space Manager サーバー用のもの、Help Advisor サーバー用のもの、さらに PCB エディター用アドオンのインターフェースなどがあります。

IServerView Interface

IServerView インターフェースは、複数種類のドキュメントを扱えるグローバル（スタンドアロン）パネルを指します。たとえば Projects パネルです。この Projects パネルは Work-space manager サーバーによって制御され、IServerView インターフェースとして表現されます。

IServerDocumentView インターフェース

PCB ドキュメントには、エディター（ドキュメント）ビューと 3 つのパネルビュー（ PCB Navigator 、Expression Filter 、Object Inspector パネル）があり、これらはすべて同じ IServerDocumentView インターフェースで表現されます。したがって、上の図では、2 つの PCB ドキュメントと 2 組の 3 つの PCB パネル（Expression Filter が List パネル、Object Inspector が Inspector パネル、そして PCB Navigator が PCB パネル）を表す 8 つの IServerDocumentView インターフェースがあります。表示されているのは PCB パネルだけですが、すべてのパネルはコンピューターのメモリ内でアクティブである点に注意してください。

クライアント／サーバー インターフェース

Altium Designer 内のクライアント／サーバー アーキテクチャで使用される主要なインターフェースは次のとおりです。

IClient シェルとそのインターフェース:

• ICommandLauncher（クライアントのプロセスランチャー テーブルを扱う）
• IProcessLauncher（クライアントからサーバープロセスを起動する処理を扱う）
• IServerDocumentView（パネルまたはサーバードキュメントを扱う）
• IProcessControl（スタックされたプロセスのレベルを判定する）
• IGUIManager（Altium Designer のユーザーインターフェース、パネルの位置および状態を扱う）
• IServerModule（Altium Designer にロードされたサーバーを扱う）
• INotification（クライアントはサーバー群または指定されたサーバーに通知メッセージをブロードキャストまたはディスパッチできる）

Altium Designer の構成インターフェース:

• IServerRecord（Altium Designer 起動時にサーバー情報を収集する - 未ロードのサーバー）
• IServerWindowKind（Altium Designer で開くドキュメント種別を決定する）
• IServerProcess（現在のサーバープロセスの情報を保持する）

IServerModule インターフェースは、Altium Designer にロードされたサーバーを表します

IServerModule インターフェースは、次のインターフェースを持ちます:
• ICommandLauncher インターフェース（サーバーのプロセス テーブルを扱う）
• IServerDocument インターフェース（Altium Designer にロードされた設計ドキュメントを表す）
• IServerView インターフェース（Altium Designer システムのビューを持てるパネルを表す）
• IServerDocumentView インターフェース（ドキュメントビュー（ドキュメント ウィンドウまたはパネル ウィンドウ）を扱う）
• IExternalForm インターフェース（ドキュメントフォームまたはパネルフォームとしての、Altium Designer 対応 Delphi フォームを表す。これらのフォームは IServerDocumentView または IServerView インターフェース オブジェクトによってラップされる。この IExternalForm インターフェース オブジェクトは、フォームのリサイズや表示などの低レベル メソッドを持つ）
• IProcessControl（このフォーカスされているサーバードキュメントに対するスタック済みプロセスのレベルを表す）
• INotification インターフェースは、クライアントシステムからのシステム通知を受信し、すべてのサーバーモジュールがこれらの通知を受け取ります。通知を処理し、そこから必要な動作を行うことができます。通知を使用して、ドキュメントと関連パネルを同期することもできます）。

IClient インターフェース

Overview
IClient インターフェース（RT_ClientServerInterface ユニット）は、Altium Designer アプリケーションの Client サブシステムを表し、Client はコマンド（あらかじめパッケージ化されたプロセスランチャー）、プロセス深度、およびドキュメントを管理します。Altium Designer にロードされたすべてのサーバーモジュールは、単一のクライアント実行可能サブシステムへのフックを持っているため、ロード済みサーバーの特定ドキュメントへアクセスしたり、サーバーコマンドを起動したりできます。

IClient シェルとそのインターフェース;

• ICommandLauncher（プロセスランチャーを扱う）
• IProcessLauncher（サーバープロセスの起動を扱う）
• IServerDocumentView（パネルまたはサーバードキュメントを扱う）
• IProcessControl（スタックされたプロセスのレベルを判定する）
• IGUIManager（ALtium Designer のユーザーインターフェース、パネルの位置および状態を扱う）
• IServerModule（ALtium Deisgner にロードされたサーバーを扱う）
• INotification（サーバー群または指定されたサーバーに通知メッセージをブロードキャストまたはディスパッチする）

スクリプト内で Client 関数を直接呼び出すことで、IClient インターフェース オブジェクトを取得できます。
IClient Methods and Properties Table

IClient メソッド

AddServerView メソッド

(IClient インターフェース)
Syntax
Procedure AddServerView (AView : IServerView);
Description
このプロシージャは、カスタムパネルのようなドキュメントビューを Altium Designer 内の Client オブジェクトに追加します。サーバーコマンドを登録する TServerModule コンストラクターでは、ここでグローバル パネルビューを作成します。TServerModule.CreateServerViews メソッドでは、グローバルパネルフォームと、そのパネルフォームから作成されたビューを用意します。その後、そのビューはサーバーモジュール（TServerModule.AddView()）とクライアントオブジェクト（Client.AddServerView）の両方に追加されます。
See also
IServerView インターフェース
IClient インターフェース
TServerModule クラス用の RT_ServerImplementation。

ApplicationIdle メソッド

(IClient インターフェース)
Syntax
Procedure ApplicationIdle;
Description
ApplicationIdle メソッドが呼び出されると、このプロシージャは Altium Designer を、Window メッセージおよび Altium Designer 固有のメッセージを処理できるモードにします。
See also
IClient インターフェース

BeginDisableInterface メソッド

(IClient インターフェース)
Syntax
Procedure BeginDisableInterface;
Description
これらの BeginDisableInterface および EndDisableInterface メソッドは、クライアントのユーザーインターフェースを無効にする必要がある場合に呼び出されます。たとえば、大規模な処理が進行中で、ユーザーによる介入を望まない場合です。
See also
EndDisableInterface メソッド
IClient インターフェース

BeginDocumentLoad メソッド

(IClient インターフェース)
Syntax
Procedure BeginDocumentLoad;
Description
BeginDocumentLoad および EndDocumentLoad プロシージャは、Altium Designer で一連のドキュメントをロードするために使用されます。
Example

Client.BeginDocumentLoad;
ServerDocument1  :=  Client.OpenDocument('Text',FileName1);
ServerDocument2  :=  Client.OpenDocument('Text',FileName2);
ServerDocument3  :=  Client.OpenDocument('Text',FileName3);
Client.EndDocumentLoad(True);

See also
EndDocumentLoad メソッド
IClient インターフェース

BeginRecoverySave メソッド

(IClient インターフェース)
Syntax
Procedure BeginRecoverySave;
Description
BeginRecoverySave および EndRecoverySave プロパティは、Altium Designer で現在の設計ドキュメントのバックアップを行う際に、ドキュメント名変更に関するクライアント通知を抑制するために使用できます。リカバリー保存プロセスが進行中かどうかを確認するには、InRecoverySave メソッドを呼び出します。
See also
EndRecoverySave メソッド
InRecoverySave メソッド
IClient インターフェース

BroadcastNotification メソッド

(IClient インターフェース)
Syntax
Procedure BroadcastNotification (ANotification : INotification);
Description
このプロシージャは Altium Designer 内で通知メッセージをブロードキャストし、アクティブなすべての設計ドキュメント／サーバーに応答の機会を与えます。BoardcastNotification は DispatchNotification (Nil, ANotification); です。Notification インターフェースには 5 つの種類があります。ISystemNotification、IDocumentNotification、IDocumentFormNotification、IViewNotification、および IModuleNotification です。
See also
DispatchNotifiaction メソッド
INotification インターフェース
IClient インターフェース

Client_CanServerStarted メソッド

(IClient インターフェース)
Syntax
Function CanServerStarted (AModuleName : PChar) : LongBool;
Description
この関数は、サーバーモジュールを Altium Designer にロードできるかどうかを確認します。StartServer 関数を呼び出す前にこれを使用してください。
See also
IClient インターフェース
StartServer メソッド

CloseDocument メソッド

(IClient インターフェース)
Syntax
Procedure CloseDocument(ADocument : IServerDocument);
Description
このプロシージャは IServerDocument パラメーターを受け取り、指定したドキュメントを閉じます（そのドキュメントがすでに Altium Designer にロードされ、開かれている場合）。なお、ドキュメントは Altium Designer から削除されるわけではありません。たとえば、そのドキュメントは依然として Projects パネル上に存在します。
See also
OpenDocument メソッド
IClient インターフェース

Count プロパティ

(IClient インターフェース)
Syntax
Property Count : Integer Read GetCount;
Description
このプロパティは、Altium Designer の現在のセッションにおけるアクティブなサーバー数を返します。ServerModule プロパティと組み合わせて使用し、Server Module インターフェースを取得します。
See also
GetCount メソッド
IServerModule インターフェース
IClient インターフェース

DispatchNotification メソッド

(IClient インターフェース)
Syntax
Procedure DispatchNotification（IClient インターフェース）
Syntax
Procedure EndDocumentLoad(AShow : LongBool);
Description
BeginDocumentLoad および EndDocumentLoad プロシージャは、Altium Designer で一連のドキュメントを読み込むために使用されます。
Example

Client.BeginDocumentLoad;
ServerDocument1  :=  Client.OpenDocument('Text',FileName1);
ServerDocument2  :=  Client.OpenDocument('Text',FileName2);
ServerDocument3  :=  Client.OpenDocument('Text',FileName3);
Client.EndDocumentLoad(True);

See関連項目
IClient インターフェース
BeginDocumentLoad メソッド

EndRecoverySave メソッド

（IClient インターフェース）
Syntax
Procedure EndRecoverySave;
Description
BeginRecoverySave および EndRecoverySave メソッドは、Altium Designer で現在の設計ドキュメントのバックアップを実行する際に、ドキュメント名の変更に関するクライアント通知を抑制するために使用できます。
リカバリ保存が進行中かどうかを確認するには、InRecoverySave メソッドを呼び出します。
See also
BeginRecoverySave メソッド
InRecoverySave メソッド
IClient インターフェース

GetApplicationHandle メソッド

（IClient インターフェース）
Syntax
Function GetApplicationHandle : Integer;
Description
このアプリケーションハンドルは、サーバーからダイアログを動的に作成する必要がある場合にサーバーコード内で使用できます。これにより、Altium Designer 上に表示されるダイアログは Altium Designer のアイコンを継承し、タスクバー上で 1 つのアプリケーションとして表示されます。
この ApplicationHandle プロパティは、ダイアログの create コンストラクタのパラメータとして渡すことができます。GetMainWindowHandle 関数はこれに相当します。
See also
GetMainWindowHandle メソッド
ApplicationHandle プロパティ
IClient インターフェース

GetCommandLauncher メソッド

（IClient インターフェース）
Syntax
Function GetCommandLauncher : ICommandLauncher;
Description
この関数は ICommandLauncher インターフェースを取得します。これは Client のプロセスランチャーを表し、サーバープロセスおよびそのパラメータの起動に使用できます。IProcessLauncher インターフェースも参照してください。
See also
ICommandLauncher インターフェース
IProcessLauncher インターフェース
IClient インターフェース

GetCount メソッド

（IClient インターフェース）
Syntax
Function GetCount : Integer;
Description
このメソッドは、Altium Designer の現在のセッションにおけるアクティブ（ロード済み）サーバーの数を返します。ServerModule インターフェースを取得するには、このメソッド（または Count プロパティ）を ServerModule プロパティと組み合わせて使用します。
See also
Count プロパティ
IClient インターフェース

GetCurrentView メソッド

（IClient インターフェース）
Syntax
Function GetCurrentView : IServerDocumentView;
Description
この関数は現在のビュー（つまり Altium Designer でフォーカスされている開いているドキュメント）を取得します。CurrentView プロパティおよび IServerDocumentView インターフェースを参照してください。
Example

Procedure  GrabACurrentDocumentView;
Var  
  ServerDocumentView  :  IServerDocumentView;
  CurrentDirectory  :  AnsiString;
Begin
  ServerDocumentView  :=  Client.GetCurrentView;
  CurrentDirectory  :=  ExtractFileDir(ServerDocumentView.GetOwnerDocument.FileName);
End;

See also
CurrentView プロパティ
IClient インターフェース

GetDefaultExtensionForDocumentKind メソッド

（IClient インターフェース）
Syntax
Function GetDefaultExtensionForDocumentKind(DocumentKind : PChar) : PChar;
Description
この関数は、document kind パラメータに基づいて、指定されたドキュメント種別のデフォルト拡張子を返します。
IClient インターフェース

GetDocumentByPath メソッド

（IClient インターフェース）
Syntax
Function GetDocumentByPath(Const AFilePath : WideString) : IServerDocument;
Description
この関数は設計ドキュメントの完全なファイルパスを取得し、そのパスが有効であれば、設計ドキュメント全体およびそのパネルを表す IServerDocument オブジェクトインターフェースを返します。
See also
IClient インターフェース

GetDocumentKindFromDocumentPath メソッド

（IClient インターフェース）
Syntax
Function GetDocumentKindFromDocumentPath (Path : PChar) : PChar;
Description
この関数は、有効な完全ドキュメントパスに基づいてドキュメント種別を返します。
See also
IClient インターフェース

GetEncryptedTechnologySets メソッド

（IClient インターフェース）
Syntax
Function GetEncryptedTechnologySets (Var ValidAtTimestamp : Cardinal) : WideString;
Description

Example

See also
IClient インターフェース

GetGUIManager メソッド

（IClient インターフェース）
Syntax
Function GetGUIManager : IGUIManager;
Description
GUI Manager インターフェースを返します。代わりに GUIManager プロパティを使用してください。このインターフェースオブジェクトは、Altium Designer のステータスバーの制御や、Altium Designer 内のパネルの位置と状態の管理など、Altium Designer のユーザーインターフェースを扱います。
See also
IGUIManager インターフェース
IClient インターフェース

GetLicenseManager 関数

（IClient インターフェース）
Syntax
Function GetLicenseManager : ILicenseManager;
Description

Example

See also
IClient インターフェース
ILicenseManager インターフェース

GetMainWindowHandle メソッド

（IClient インターフェース）
Syntax
Function GetMainWindowHandle : Integer;
Description
このアプリケーションハンドルは、サーバーからダイアログを動的に作成する必要がある場合にサーバーコード内で使用できます。これにより、Altium Designer 上に表示されるダイアログは Altium Designer のアイコンを継承し、タスクバー上で 1 つのアプリケーションとして表示されます。この ApplicationHandle プロパティもこれに相当します。
See also
GetApplicationHandle メソッド
ApplicationHandle プロパティ
IClient インターフェース

GetNavigationSystem メソッド

（IClient インターフェース）
Syntax
Function GetNavigationSystem : INavigationSystem;
Description
この関数は Navigation system インターフェースを返します。
See also
INavigationSystem インターフェース
IClient インターフェース

GetOptionsManager 関数

（IClient インターフェース）
Syntax
Function GetOptionsManager : IOptionsManager;
Description
このメソッドは IOptionsManager インターフェースを取得します。このインターフェースを使用すると、GetOptionsReader または GetOptionsWriter を呼び出して、対象サーバーのオプション（設定）を取得または書き込むことができます。各エディターサーバーには、そのサーバードキュメントを管理するオプションがあります。
Example

Var
Reader : IOptionsReader;
Begin
Reader := Client.OptionsManager.GetOptionsReader(NameOfServer,'');
If Reader = Nil Then Exit;

AValue := Reader.ReadBoolean(NameOfServerPreferences,SettingName,DefaultValue);
End;

See also
IClient インターフェース
IOptionsManager

GetOptionsSetByName メソッド

（IClient インターフェース）
Syntax
Function GetOptionsSetByName (Const AName : Widestring) : IDocumentOptionsSet;
Description
この関数は、有効な Name 文字列に基づいて IDocumentOptionsSet インターフェースを取得します。
See also
GetOptionsSetCount メソッド
GetOptionsSet メソッド
IDocumentOptionsSet インターフェース
IClient インターフェース

GetOptionsSetCount メソッド

（IClient インターフェース）
Syntax
Function GetOptionsSetCount : Integer;
Description
この関数は Options Set の数を返します。
See also
GetOptionsSet メソッド
GetOptionsSetByName メソッド
IClient インターフェース

GetOptionsSet メソッド

（IClient インターフェース）
Syntax
Function GetOptionsSet (Index : Integer) : IDocumentOptionsSet;
Description
この関数は、指定したインデックスの Options Set（IDocumentOptionsSet 型）を返します。
See also
GetOptionsSetCount メソッド
GetOptionsSetByName メソッド
IClient インターフェース

GetPanelInfoByName メソッド

（IClient インターフェース）
Syntax
Function GetPanelInfoByName (Const APanelName : Widestring)
: IServerPanelInfo;
Description
この関数は、指定したパネルに対する IServerPanelInfo インターフェースを取得します。
See also
IServerPanelInfo インターフェース
IClient インターフェース

GetProcessControl メソッド

（IClient インターフェース）
Syntax
Function GetProcessControl : IProcessControl;
Description
Process Control インターフェースを返します。この Process Control は、発生している「再入可能」プロセスの数、すなわち別のアクティブなクライアントプロセスの上に積み重なって発生している 1 つのクライアントプロセスの数を判定します。これがプロセス深度です。Process Control のプロセス深度が 0 の場合、Altium Designer では何も実行されていないことを示します。
See also
IProcessControl インターフェース
IClient インターフェース

GetRealMainWindowHandle メソッド

（IClient インターフェース）
Syntax
Function GetRealMainWindowHandle : THandle;
Description
この関数は、Altium Designer のメインウィンドウのウィンドウハンドルを返します。
See also
IClient インターフェース

GetServerNameByPLID メソッド

（IClient インターフェース）
Syntax
Function GetServerNameByPLID(APLID : PChar) : PChar;
Description
この関数は、PLID 識別子文字列（サーバーのリソースファイルから抽出された文字列）に基づいてサーバー名を返します。
See also
IClient インターフェース

GetServerModule メソッド

（IClient インターフェース）
Syntax
Function GetServerModule(Index : Integer) : IServerModule;
Description
ServerModule プロパティは Count プロパティと組み合わせて、アクティブ（ロード済み）サーバーを取得するために使用します。ServerModule プロパティは、Altium Designer でロードされたサーバーモジュールに対する IServerModule インターフェースを返します。
なお、PCB サーバーおよび Schematic サーバーには、それぞれ独自の IPCB_ServerInterface インターフェースおよび ISch_ServerInterface インターフェースがあります。
IServerModule example
この例では、Schematic の IServerModule インターフェースを取得し、Altium Designer で開いているドキュメントビューの数を返します

Var
  ServerModule  :  IServerModule;
Begin
  If  Client  =  Nil  Then  Exit;

  ServerModule  :=  Client.ServerModuleByName('SCH');
  ShowMessage('Doc  Count  =  '  +  IntToStr(ServerModule.DocumentCount));
End;

See also
Count プロパティ
IServerModule プロパティ
ServerModuleByName プロパティ
IClient インターフェース

GetServerModuleByName メソッド

（IClient インターフェース）
Syntax
Function GetServerModuleByName (Const AModuleName : Widestring) : IServerModule;
Description
この関数は、AModuleName パラメータの有効性に応じてサーバーモジュールインターフェースを返します。例としては 'PCB' や 'SCH' があります。インデックス指定のサーバーモジュールを返すには、代わりに ServerModuleByName プロパティを使用してください。
Example

Var
  ServerModule  :  IServerModule;
Begin
  If  Client  =  Nil  Then  Exit;

  ServerModule  :=  Client.ServerModuleByName('SCH');
  ShowMessage('Doc  Count  =  '  +  IntToStr(ServerModule.DocumentCount));
End;

See also
GetServerModule メソッド
ServerModule プロパティ
IClient インターフェース

GetServerRecord メソッド

（IClient インターフェース）
Syntax
Function GetServerRecord (Index : Integer) : IServerRecord;
Description
GetServerRecord 関数は、Altium Designer のインストール先の System フォルダにあるインストール *.INS ファイルに基づいて、インストール済みサーバーの数を報告します）。この関数は GetServerRecordCount 関数と組み合わせて使用します。
IClient インターフェースには GetServerRecord メソッドと GetServerModule メソッドがあります。これら 2 つのメソッドの違いは、GetServerRecord 関数がインストール済みサーバーの数（Altium Designer のインストール先 \System\ フォルダ内の *.INS ファイル）を報告する点です。
GetServerModule は、Altium Designer 内でアクティブ（ロード済み）のサーバーを返すだけです。各アクティブサーバーを取得するには、GetCount 関数を呼び出し、そのカウントパラメータを GetServerModule 関数に渡す必要があります。
See also
GetServerRecordCount メソッド
GetServerModule メソッド
IClient インターフェース

GetServerRecordCount メソッド

（IClient インターフェース）
Syntax
Function GetServerRecordCount : Integer;
Description
この関数は、Altium Designer ソフトウェアのインストール先 \System\ フォルダで見つかったサーバーインストールファイルを表すサーバーレコードの数を返します。GetServerRecord 関数と組み合わせて使用します。
See also
IServerRecord インターフェース
IClient インターフェース

GetServerRecordByName メソッド

（IClient インターフェース）
Syntax
Function GetServerRecordByName(AModuleName : WideString) : IServerRecord;
Description
この関数は、AModuleName パラメータに基づいて IServerRecord インターフェースを返します。この IServerRecord インターフェースは、サーバーのインストールファイル（INS 拡張子付き）を表します。
Example

Var
  ClientModule  :  IClient;
  ServerRecord  :  IServerRecord;
  Version  :  WideString;
Begin
  ClientModule  :=  Client;
  If  ClientModule  =  Nil  Then  Exit;

  //The  IServerRecord  interface  encapsulates  the  details
  //  of  a  server's  installation  file

  //We  are  interested  in  the Altium Designer's  Client  Module
  //  and  fetch  the  product  version.
  ServerRecord  :=  ClientModule.GetServerRecordByName('CLIENT');
  Version  :=  ServerRecord.GetVersion;

  ShowMessage(Version);
End;

See also
IServerRecord インターフェース

IClient インターフェース

GetServerViewFromName メソッド

（IClient インターフェース）
Syntax
Function GetServerViewFromName (Const ViewName : Widestring) : IServerView;
Description
この関数は、サーバービューの名前に応じてサーバービューオブジェクトインターフェースを返します。IServerView インターフェースは、パネルビューを表すとともに、ドキュメントビューの祖先でもあります。
See also
IExternalForm インターフェース
IServerView インターフェース
OpenDocument メソッド
ShowDocument メソッド
IServerDocument インターフェース
IClient インターフェース

OpenDocumentShowOrHide メソッド

(IClient インターフェース)
Syntax
Function OpenDocumentShowOrHide (Const AKind, AFileName : WideString; AShowInTree : Boolean) : IServerDocument;
Description
この関数は特定のドキュメントを開きますが、Altium Designer ワークスペース内での表示方法を制御できます。
See also
IClient インターフェース

HandleException メソッド

(IClient インターフェース)
Syntax
Procedure HandleException (Const AMessage : WideString);
Description

Example

See also
IClient インターフェース

InRecoverySave メソッド

(IClient インターフェース)
Syntax
Function InRecoverySave : LongBool
Description
この関数は、BeginRecoverySave メソッドまたは EndRecoverySave メソッドを呼び出す前に、Altium Designer が Recovery Save モードの処理中かどうかを確認します。
See also
BeginRecoverySave メソッド
EndRecoverySave メソッド
IClient インターフェース

IsDocumentOpen メソッド

(IClient インターフェース)
Syntax
Function IsDocumentOpen (Const AFilePath : PChar) : LongBool;
Description
ドキュメントが Altium Designer で開かれているかどうかを示すブール値を返します。この結果は、AFilePath パラメータが有効かどうかに依存します。
See also
IClient インターフェース

IsQuitting メソッド

(IClient インターフェース)
Syntax
Function IsQuitting : Boolean;
Description
Altium Designer の状態を表すブール値を返します。Altium Designer が終了しようとしている、または終了処理中の場合は True、まだアクティブな場合は False です。
See also
IClient インターフェース

LastActiveDocumentOfType メソッド

(IClient インターフェース)
Syntax
Function LastActiveDocumentOfType (Const AType : Widestring) : IServerDocument;
Description
この関数は、ドキュメント種別に基づいて、Altium Designer 内で最後にアクティブだった読み込み済みドキュメントを返します。種別には PCB、SCH、TEXT、WAVE、PCBLIB、SCHLIB があります。
See also
IClient インターフェース

IsInitialized 関数

(IClient インターフェース)
Syntax
Function IsInitialized : LongBool;
Description

Example

See also
Client インターフェース

LicenseInfoStillValid メソッド

(IClient インターフェース)
Syntax
Function LicenseInfoStillValid (Const RetrievedAt : Cardinal) : LongBool;
Description

See also
IClient インターフェース

MainWindowHandle プロパティ

(IClient インターフェース)
Syntax
Property MainWindowHandle : Integer Read GetMainWindowHandle;
Description
MainWindowHandle プロパティは、Altium Designer のメインウィンドウのハンドルを返します。これは、Altium Designer に関連付けられるアドオンダイアログで使用でき、たとえばタスクバー上では Altium Designer のアイコンが 1 つだけ表示されるようにできます。
See also
GetMainWindowHandle メソッド
ApplicationHandle プロパティ
IClient インターフェース

OpenDocument メソッド

(IClient インターフェース)
Syntax
Function OpenDocument (Const AKind, AFileName : PChar) : IServerDocument;
Description
OpenDocument メソッドは、このドキュメントの DocumentKind および FileName の値が有効な場合に、IServerDocument インターフェースを返します。
Example

Var
  ReportDocument  :  IServerDocument;
Begin
  ReportDocument  :=  Client.OpenDocument('Text',FileName);
  If  ReportDocument  <>  Nil  Then
  Client.ShowDocument(ReportDocument);
End

See also
ShowDocument メソッド
IClient インターフェース

OpenNewDocument メソッド

(IClient インターフェース)
Syntax
Function OpenNewDocument (Const AKind, AFileName, ANewName : Widestring; ReuseExisting : Boolean) : IServerDocument;
Description

Example

See also
IClient インターフェース

QuerySystemFont メソッド

(IClient インターフェース)
Syntax
Procedure QuerySystemFont ( QueryMode : TFontQueryMode;
Var AUseSysFont : Boolean;
Var AFontName : WideString;
Var AFontSize : Integer;
Var AFontStyle : TFontStyles;
Var AFontColor : TColor;
Var AFontCharset : TFontCharset);
Description
使用されているシステムフォントを取得します。
See also
IClient インターフェース

RegisterNotificationHandler メソッド

(IClient インターフェース)
Syntax
Procedure RegisterNotificationHandler(Const Handler : INotificationHandler);
Description
RegisterNotificationHandler メソッドは、サーバーオブジェクトが作成されてコンピュータメモリに読み込まれた後、その通知ハンドラを Altium Designer の Client モジュール部分に登録します。Handler パラメータにはサーバーモジュールオブジェクトが含まれます。
Notes
INotificationHandler オブジェクトインターフェースは、Altium Designer で発生した通知を処理する役割を持ちます。
各サーバーオブジェクトには、システム全体の Preferences ダイアログでオプション値が調整されたときに通知を処理する HandleNotification プロシージャがあります。
たとえば、特定のサーバー通知コードが検出されるたびに、HandleNotification プロシージャではサーバーパネル上のサーバー設定値を更新する呼び出しを行います。
このメソッドは通常、スクリプトではなくサーバー開発で使用されます。
See also
BroadcastNotification メソッド
DispatchNotification メソッド
UnRegisterNotificationHandler メソッド
INotificationHandler インターフェース
IClient インターフェース

RemoveServerView メソッド

(IClient インターフェース)
Syntax
Procedure RemoveServerView (Const AView : IServerView);
Description
このプロシージャは、サーバービュー（サーバードキュメントウィンドウを表す）を Altium Designer から削除します。
See also
GetCurrentView メソッド
IClient インターフェース

ShowDocumentDontFocus メソッド

(IClient インターフェース)
Syntax
Procedure ShowDocumentDontFocus(ADocument : IServerDocument);
Description
このプロシージャは IServerDocument パラメータを取得し、その設計ドキュメントを表示しますが、以前にフォーカスされていたドキュメントのフォーカスは維持されます。まだ設計ドキュメントが何も開かれていない場合でも、この設計ドキュメントは表示されますが、フォーカスはされません。
See also
OpenDocument メソッド
ShowDocument メソッド
IServerDocument インターフェース
IClient インターフェース

ShowDocument メソッド

(IClient インターフェース)
Syntax
Procedure ShowDocument (ADocument : IServerDocument);
Description
このプロシージャは、Altium Designer に読み込まれている Server Document を表す IServerDocument パラメータを取得し、その設計ドキュメントを Altium Designer に表示します。
IServerDocument example
この例では、client インターフェースを取得してからドキュメントを開いて表示します。

Procedure  OpenAndShowADocument(Filename  :  TDynamicString);
Var
  ReportDocument  :  IServerDocument;
Begin
  If  Client  =  Nil  Then  Exit;
  ReportDocument  :=  Client.OpenDocument('Text',FileName);
  If  ReportDocument  <>  Nil  Then
  Client.ShowDocument(ReportDocument);
End;

See also
OpenDocument メソッド
IServerDocument インターフェース
IClient インターフェース

SetCurrentView メソッド

(IClient インターフェース)
Syntax
Procedure SetCurrentView(Value : IServerDocumentView);
Description
このプロシージャは IServerDocumentView パラメータを取得し、このドキュメントフォームを Altium Designer の現在のビューとして設定します。
See also
GetCurrentView メソッド
CurrentView プロパティ
IClient インターフェース

StopServer メソッド

(IClient インターフェース)
Syntax
Function StopServer (AModuleName : WideString) : Boolean;
Description
StartServer プロパティおよび StopServer プロパティは、まだ読み込まれていないサーバーを Altium Designer に読み込んでからそのサーバーのプロセスを呼び出し、処理完了後にそのサーバーを停止するために使用できます。これによりコンピュータのメモリを節約できます。
StartServer 関数は通常、サーバーがまだ読み込まれていない状態で設計ドキュメントを読み込み、そのサーバーのプロセスや API 関数を実行する必要がある場合に使用されます。たとえば、PCB ドキュメントが 1 つも開かれていない Altium Designer の空のセッション中に、PCB ドキュメント上の内容を操作するために PCB API を使用する必要がある場合は、まず PCB サーバーを「開始」して PCB API を有効にする必要があります。
Example of the StopServer メソッド
Client.StopServer('PCB');
See also
StartServer メソッド
IClient インターフェース

StartServer メソッド

(IClient インターフェース)
Syntax
Function StartServer (AModuleName : WideString) : Boolean;
Description
StartServer プロパティおよび StopServer プロパティは、まだ読み込まれていないサーバーを Altium Designer に読み込んでからそのサーバーのプロセスを呼び出し、処理完了後にそのサーバーを停止するために使用できます。これによりコンピュータのメモリを節約できます。
StartServer 関数は通常、サーバーがまだ読み込まれていない状態で設計ドキュメントを読み込み、そのサーバーのプロセスや API 関数を実行する必要がある場合に使用されます。たとえば、PCB ドキュメントが 1 つも開かれていない Altium Designer の空のセッション中に、PCB ドキュメント上の内容を操作するために PCB API を使用する必要がある場合は、まず PCB サーバーを「開始」して PCB API を有効にする必要があります。
Example of the StartServer メソッド
Client.StartServer('PCB');
See also
StopServer メソッド
IClient インターフェース

UnregisterNotificationHandler メソッド

(IClient インターフェース)
Syntax
Procedure UnregisterNotificationHandler(Const Handler : INotificationHandler);
Description
UnregisterNotificationHandler メソッドは、サーバーオブジェクトがスコープ外になったとき（破棄されたとき）に、Client から通知ハンドラの登録を解除します。Handler パラメータにはサーバーモジュールオブジェクトが含まれます。
Notes
INotificationHandler オブジェクトインターフェースは、Altium Designer で発生した通知を処理する役割を持ちます。
各サーバーオブジェクトには、システム全体の Preferences ダイアログでオプション値が調整されたときに通知を処理する HandleNotification プロシージャがあります。
たとえば、特定のサーバー通知コードが検出されるたびに、HandleNotification プロシージャではサーバーパネル上のサーバー設定値を更新する呼び出しを行います。
このメソッドは通常、スクリプトではなくサーバー開発で使用されます。
See also
BroadcastNotification
DispatchNotification
RegisterNotificationHandler メソッド
INotificationHandler インターフェース
IClient インターフェース

AddViewToFavorites メソッド

(IClient インターフェース)
Syntax
Function AddViewToFavorites(Const AView : IServerDocumentView; AIsSnippet : Boolean) : Boolean;
Description

Example

See also
IClient インターフェース

GetDynamicHelpManager メソッド

(IClient インターフェース)
Syntax
Function GetDynamicHelpManager : IDynamicHelpManager;
Description
このメソッドは Dynamic Help マネージャを返します。これは Altium Designer の Knowledge Center パネルを表します。
See also
IClient インターフェース
IDynamicHelpManager インターフェース。

IClient プロパティ

ApplicationHandle プロパティ

(IClient インターフェース)
Syntax
Property ApplicationHandle : Integer
Description
ApplicationHandle プロパティは、サーバー内でアプリケーションハンドルを設定します。これは、サーバーからダイアログを動的に作成する必要がある場合に使用され、Altium Designer の前面に表示されるダイアログは毎回 Altium Designer のアイコンを継承し、タスクバー上では 1 つのアプリケーションとして表示されます。
たとえば、この ApplicationHandle プロパティは動的ダイアログの create コンストラクタへのパラメータとして渡すことができます。
Note
通常、スクリプト作成者がこの applicationhandle プロパティを気にする必要はありません。このプロパティは、Altium Designer SDK の一部としてサーバー作成者が使用します。
Server Example
サーバープロジェクトのメインユニット内

Function  ServerFactory  (AClient  :  IClient)  :  IServerModule;  Safecall;
Begin
  Result  :=  TAddOn.Create(AClient,  'AddOn');
  Application.Handle  :=  Client.ApplicationHandle;
End;

サーバープロジェクトのコマンドユニット内

Procedure  DisplayResultsOnDialog(PadCount  :  TDynamicString);
Var
  DisplayForm  :  TDialog;
Begin
  DisplayForm  :=  TDialog.Create(Application);
  DisplayForm.Label1.Caption  :=  PadCount;
  DisplayForm.ShowModal;
  DisplayForm.Free;
End;

See also
IClient インターフェース

CommandLauncher プロパティ

(IClient インターフェース)
Syntax
Property CommandLauncher : ICommandLauncher Read GetCommandLauncher;
Description
CommandLauncher プロパティは Command Launcher インターフェースを返します。このインターフェースには、コマンドの起動に使用できる client のプロセスランチャーのテーブルが含まれています。
Example

If  StringsEqual(ServerModule.ModuleName,'TextEdit')  Then
Begin
  Client.CommandLauncher.LaunchCommand(
  'TextEdit:MoveCursorToTopOfDocument',
  Nil,0,ServerDocument.View[0]);
End;

GetCommandLauncher example

ACommandLauncher  :=  Client.GetCommandLauncher;
If  ACommandLauncher  <>  Nil  Then
Begin
  ACommandLauncher.GetCommandState(Command,
  Parameters,
  View,
  Enabled,
  Checked,
  Visible,
  Caption,
  Image);
End;

See also
GetCommandLauncher メソッド
IProcessLauncher インターフェース
ICommandLauncher インターフェース
IClient インターフェース

CurrentView プロパティ

(IClient インターフェース)
Syntax
Property CurrentView : IServerDocumentView Read GetCurrentView Write SetCurrentView;
Description
このプロパティは、Altium Designer における現在の設計ドキュメントビューを表す現在のドキュメントビューインターフェースを返します。
SendMessage Example

Client.SendMessage('PCB:Zoom', 'Action=Redraw' , 255, Client.CurrentView); 

CurrentView example

Procedure  GrabACurrentDocumentView;
Var  
  ServerDocumentView  :  IServerDocumentView;
  FileName  :  WideString;
Begin
  ServerDocumentView  :=  Client.CurrentView;
  FileName  :=  ServerDocumentView.GetOwnerDocument.FileName;
End;

ViewName example

If StrPas(Client.CurrentView.ViewName) <> UpperCase('PCBLib') Then Exit; 

このコードスニペットでは、現在のドキュメントの種類を確認するために Client.CurrentView.ViewName メソッドを使用しています。

See also
GetCurrentView メソッド
SetCurrentView メソッド
IServerDocumentView インターフェース
IClient インタ(IClient インターフェース)
Syntax
Property GUIManager : IGUIManager Read GetGUIManager;
Description
GUIManager プロパティは GUIManager インターフェースを返します。この Interface オブジェクトは、ステータスバーの制御、パネルの位置や状態など、Altium Designer のグラフィカルユーザーインターフェースを扱います。
See also
IGUIManager インターフェース
IClient インターフェース

NavigationSystem プロパティ

(IClient インターフェース)
Syntax
Property NavigationSystem : INavigationSystem Read GetNavigationSystem;
Description
NavigationSystem プロパティは、Altium Designer のナビゲーションシステムを表します。ナビゲーションシステムは Navigation パネルの中核となる機能であり、設計プロジェクトのネット接続性の中心を担います。設計は、コンパイル済みシートのリスト、フラット化された階層、構造ツリーの 3 つの方法で構成できます。
Example

See also
IClient インターフェース
INavigationSystem インターフェース

ProcessControl プロパティ

(IClient インターフェース)
Syntax
Property ProcessControl : IProcessControl Read GetProcessControl;
Description
このプロパティは IProcessControl インターフェースを返します。この Process Control インターフェースは、発生している「再入可能」プロセスの数、つまり、あるクライアントのプロセスの上に別のアクティブなクライアントのプロセスが積み重なって実行される状態を判定します。これがプロセス深度です。プロセス制御のプロセス深度がゼロの場合、Altium Designer では何も実行されていないことを示します。詳細は IProcessControl インターフェースを参照してください。
ProcessDepth Example
ShowMessage('Current process depth ',IntToStr(Client.ProcessControl.ProcessDepth));
See also
IClient インターフェース
IProcessControl インターフェース

ServerModule プロパティ

(IClient インターフェース)
Syntax
Property ServerModule Integer : IServerModule Read GetServerModule;
Description
ServerModule プロパティは Count プロパティと組み合わせて使用し、アクティブな（ロード済みの）サーバーを取得します。ServerModule プロパティは、Altium Designer にロードされているサーバーモジュールの IServerModule インターフェースを返します。
なお、PCB サーバーおよび Schematic サーバーには、それぞれ独自の IPCB_ServerInterface および ISch_ServerInterface インターフェースがあります。
IServerModule example
この例では、Schematic の IServerModule インターフェースを取得し、Altium Designer で開いているドキュメントビューの数を返します

Var
  ServerModule  :  IServerModule;
Begin
  If  Client  =  Nil  Then  Exit;

  ServerModule  :=  Client.ServerModuleByName('SCH');
  ShowMessage('Doc  Count  =  '  +  IntToStr(ServerModule.DocumentCount));
End;

See also
IClient インターフェース
Count プロパティ
GetServerModule メソッド
IServerModule インターフェース

ServerModuleByName プロパティ

(IClient インターフェース)
Syntax
Property ServerModuleByName Widestring : IServerModule Read GetServerModuleByName;
Description
ServerModuleByName プロパティは、モジュール名が Client のアクティブサーバーテーブル内で見つかった場合に IServerModule インターフェースを返します。PCB エディターのモジュール名は PCB、Schematic Editor のモジュール名は SCH などです。
Server Names

Example

Var
  ServerModule  :  IServerModule;
Begin
  If  Client  =  Nil  Then  Exit;

  ServerModule  :=  Client.ServerModuleByName('SCH');
  ShowMessage('Doc  Count  =  '  +  IntToStr(ServerModule.DocumentCount));
End;

See also
IClient インターフェース
IServerModule インターフェース

TimerManager プロパティ

(IClient インターフェース)
Syntax
Property TimerManager : ITimerManager Read GetTimerManager;
Description
このプロパティは、タイマーマネージャーオブジェクトのインターフェースを返します。
See also
IClient インターフェース
ITimerManager インターフェース

OptionsManager プロパティ

(IClient インターフェース)
Syntax
Property OptionsManager : IOptionsManager Read GetOptionsManager;
Description
これは読み取り専用プロパティで、IOptionsManager インターフェースを返します。このインターフェースは、指定されたサーバーについて、Altium Designer のシステム全体の Preferences ダイアログへの値の管理（読み取りおよび書き込み）を担当します。
このインターフェースは、システム全体の Preferences ダイアログに独自のオプションページを追加し、それらのオプションページ上のコントロールを管理したいサーバー作成者にとって有用です。
Example

Var
  Reader  :  IOptionsReader;
Begin
  Reader  :=  Client.OptionsManager.GetOptionsReader(NameOfServer,'');
  If  Reader  =  Nil  Then  Exit;

  AValue  :=  Reader.ReadBoolean(NameOfServerPreferences,SettingName,DefaultValue);
End;

See also
IClient インターフェース
IOptionsManager インターフェース

IServerModule インターフェース

Overview
サーバーは自身のサーバードキュメントを扱います。設計ドキュメントの種類は複数あり、たとえば Schematic Editor には Schematic と Schematic Library の 2 つのドキュメントタイプがあります。
各設計ドキュメントにはビューが格納され、ビューはドキュメントウィンドウまたはパネルウィンドウです。サーバーは、1 つのドキュメントビューに対して複数のパネルビューをホストすることができます。以下の図を参照してください。
またサーバーは、システム状態を表し、特定の設計ドキュメントに必ずしも結び付かない複数のグローバルパネルビューをホストすることもできます（たとえば Work-Space Manager サーバーには Message、Differences、Errors パネルがあります）。このドキュメントビュー / 複数パネルビュー構造は、Altium Designer のクライアント / サーバーアーキテクチャの基盤です。
これらの IServerModule インターフェース（RT_ClientServerInterface ユニット内）は、Altium Designer にロードされたサーバーを表します。このアプリケーションは、異なるサーバーモジュールの単一インスタンスを管理します。各サーバーは複数のサーバードキュメント種別を持つことができ、たとえば PCB サーバーは PCB および PCBLIB 設計ドキュメントの 2 つのサーバードキュメント種別をサポートしています。Altium Designer にロードされたサーバーは通常ドキュメントをホストし、各ドキュメントはさらにドキュメントビューとパネルビューをホストします。
以下の図は、サーバードキュメントを持つサーバーモジュールを表しています。各ドキュメントにはビュー、すなわちドキュメントビューと関連するパネルビューがあります。

Notes
IServerModule インターフェースには、次のインターフェースがあります。
• ICommandLauncher はサーバーのプロセステーブルを扱います
• IServerDocument は Altium Designer にロードされた設計ドキュメントを表します
• IServerView は Altium Designer システムのビューを持てるパネルを表します
• IServerDocumentView はドキュメントビュー（ドキュメントウィンドウまたはパネルウィンドウのいずれか）を扱います
• IExternalForm は、ドキュメントフォームまたはパネルフォームとして動作する、Altium Designer 対応の Delphi フォームを表します。これらのフォームは IServerDocumentView または IServerView インターフェースオブジェクトによってラップされます。この IExternalForm インターフェースオブジェクトには、フォームのサイズ変更や表示などの低レベルメソッドがあり、IServerDocumentView および IServerView インターフェースの祖先インターフェースです。
• IProcessControl は、このフォーカスされているサーバードキュメントに対する積み重なったプロセスのレベルを表します
• INotification は Client システムからのシステム通知を受け取り、すべてのサーバーモジュールがこれらの通知を受信します。通知を処理して、そこから対応を続けることができます。通知を利用して、ドキュメントと関連パネルを同期させることもできます。
Notes
PCB サーバーモジュールには、独自の IPCB_ServerInterface インターフェースもあります。
Schematic Server モジュールにも、独自の ISCH_ServerInterface インターフェースがあります。
ただし、両方のサーバーはこの IServerModule インターフェースも備えています。
IServerModule Methods and Properties Table

See also
IPCB_ServerInterface インターフェース
ISCH_ServerInterface インターフェース

IServerModule GetState および SetState メソッド

GetClient メソッド

(IServerModule インターフェース)
Syntax
Function GetClient : IClient;
Description
GetClient メソッドは、Altium Designer のクライアントサブシステムの IClient インターフェースを返します。この IClient インターフェースを使用して、そのメソッドを呼び出すことができます。
GetClient メソッドは Client プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetCommandLauncher メソッド

(IServerModule インターフェース)
Syntax
Function GetCommandLauncher : ICommandLauncher;
Description
CommandLauncher 関数は ICommandLauncher インターフェースを返します。これは、サーバーモジュールからプロセスを起動するために使用されます。CommandLauncher オブジェクトにはコマンドテーブルが含まれており、実行時にプロセス名をそのプロセスを実装する実際の関数に関連付けます。
サーバー内でプロセスが呼び出されるたびに、このテーブルが参照され、実際の関数ポインターが検索されます。プロセス名がこのテーブル内に見つからない場合は、何も実行されません。
この CommandLauncher オブジェクトは、サーバープロジェクトの main.pas ユニットで初期化されます。詳細は ICommandLauncher インターフェースを参照してください。
このメソッドは CommandLauncher プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetDocumentCount メソッド

(IServerModule インターフェース)
Syntax
Function GetDocumentCount : Integer;
Description
DocumentCount メソッドは、Document Kind の数を返します。重要な点として、View が実際の設計ドキュメントです。Document type は、特定の View を格納するコンテナです。
このメソッドは DocumentCount プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetDocuments メソッド

(IServerModule インターフェース)
Syntax
Function GetDocuments (Index : Integer) : IServerDocument;
Description
エディタータイプのサーバーは、Schematic Editor や PCB Editor のように異なるドキュメントタイプを持つことができます。これらのエディターサーバーには、それぞれ 2 つのドキュメントタイプ、つまり SCH/SCHLIB および PCB/PCBLIB があります。
アドオンタイプのサーバーは通常ドキュメントコンテナを持ちません。これは、エディターサーバーに付随する形で動作し、エディターサーバーの API サービスを利用するためです。
このメソッドは、IServerDocument インターフェースで表される、インデックス指定されたドキュメントコンテナを返します。
このメソッドは Documents プロパティで使用されます。
Example

See also
IServerModule インターフェース
IServerDocument インターフェース

GetHandle メソッド

(IServerModule インターフェース)
Syntax
Function GetHandle : THandle;
Description
このメソッドはサーバーのハンドルを返します。
このメソッドは Handle プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetModuleName メソッド

(IServerModule インターフェース)
Syntax
Function GetModuleName : Widestring;
Description
このメソッドは、このサーバーのモジュール名を返します。
たとえば、texteditor サーバーのモジュール名は TextEdit です。このサーバー名プロパティは、関連するサーバーインストールファイル（拡張子 INS のファイル）で定義されます。
このメソッドは ModuleName プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetProcessControl メソッド

(IServerModule インターフェース)
Syntax
Function GetProcessControl : IProcessControl;
Description
このメソッドは IProcessControl インターフェースを返します。このインターフェースは、Altium Designer 内の各設計ドキュメントに対するプロセス深度を制御します。
ドキュメント上でプロセスが起動されるたびに、プロセス深度は 1 増加し、同じプロセスの実行が完了すると 1 減少します。プロセス深度がゼロの場合、現在の設計ドキュメント上では何も実行されていないことを示します。
この読み取り専用プロパティは、GetProcessControl メソッドによってサポートされます。
Example

See also
IServerModule インターフェース

GetViewCount メソッド

(IServerModule インターフェース)
Syntax
Function GetViewCount : Integer;
Description
ViewCount メソッドは、指定されたサーバーのビュー数を返します。
View オブジェクトは、通常その関連サーバーによってサポートされるグローバルパネルとして、Altium Designer 内のフォーム / ウィンドウオブジェクトをカプセル化します。
このメソッドは ViewCount プロパティで使用されます。
Example

See also
IServerModule インターフェース

GetViewsIServerModule のメソッド

AddServerView メソッド

(IServerModule インターフェース)
Syntax
Procedure AddServerView (Const AView : IServerView);
Description
このプロシージャは、Server Module にパネルを追加し、この新しいパネルをモジュールで使用できるようにします。
CreateServerView 関数で IServerView オブジェクトを作成した後にこの関数を呼び出すか、IServerView インターフェースのパラメーターを渡してください。
Example

See also
IServerModule インターフェース
IServerView インターフェース

ApplicationIdle メソッド

(IServerModule インターフェース)
Syntax
Procedure ApplicationIdle;
Description
ApplicationIdle プロシージャは、Altium Designer がアイドル状態のときに呼び出される内部プロシージャです。アクティブに動作しているすべてのサーバーの ApplicationIdle プロシージャが呼び出されます。Altium Designer によって送信されたメッセージは、追跡処理される機会を得ます。
Example

See also
IServerModule インターフェース

CreateDocument メソッド

(IServerModule インターフェース)
Syntax
Function CreateDocument (Const AKind, AFileName : Widestring) : IServerDocument;
Description
CreateDocument 関数は、AKind および AFileName パラメーターに基づいて、サーバーがサポートするドキュメントを作成します。
AKind パラメーターはサーバーがサポートするドキュメント種別を表し、AFileName パラメーターは新しいドキュメントに割り当てられます。
Example

See also
IServerModule インターフェース

CreateServerDocView メソッド

(IServerModule インターフェース)
Syntax
Function CreateServerDocView (Const AName : Widestring; Const ADocument : IServerDocument): IServerDocumentView;
Description
CreateServerDocView 関数は、ドキュメントビューの名前と IServerDocument コンテナーに基づいて、IServerDocumentView（ドキュメント本体、またはそれに関連付けられたパネルビュー）オブジェクトを作成します。
Example

See also
IServerModule インターフェース

CreateServerView メソッド

(IServerModule インターフェース)
Syntax
Function CreateServerView (Const AName : Widestring) : IServerView;
Description
CreateServerView 関数は、システムパネルを表す IServerView オブジェクトを作成します。このオブジェクトを Altium Designer 内に追加するには、AddServerView プロシージャを呼び出す必要があります。
Example

See also
IServerModule インターフェース

CreateOptionsView メソッド

(IServerModule インターフェース)
Syntax
Function CreateOptionsView (Const AName : Widestring) : IDocumentOptionsView;
Description
CreateOptionsView は、Altium Designer のシステム全体の Preferences ダイアログで使用する IDocumentOptions ビューを作成します。
Example

See also
IServerModule インターフェース

DestroyDocument メソッド

(IServerModule インターフェース)
Syntax
Procedure DestroyDocument (Const ADocument : IServerDocument);
Description
DestroyDocument プロシージャは、ADocument パラメーターで指定された設計ドキュメントを閉じて削除します。
Example

See also
IServerModule インターフェース

ReceiveNotification メソッド

(IServerModule インターフェース)
Syntax
Procedure ReceiveNotification (Const ANotification : INotification);
Description
サーバーモジュールの ReceiveNotification プロシージャは、Altium Designer によってブロードキャストされる通知をインターセプトします。
システムには BroadCastNotification または DispatchNotification 関数があり、Altium Designer 内で動作しているすべてのサーバーがそれを受信し、適宜処理できます。
このプロシージャはオーバーライドして実装する必要があります。
Example

See also
IServerModule インターフェース

RemoveServerView メソッド

(IServerModule インターフェース)
Syntax
Procedure RemoveServerView (Const AView : IServerView);
Description
RemoveServerView プロシージャは、システムパネルを表す Altium Designer 内の IServerView オブジェクトを削除します。
Example

See also
IServerModule インターフェース

CreateDocumentShowOrHide メソッド

(IServerModule インターフェース)
Syntax
Function CreateDocumentShowOrHide(Const AKind, AFileName : Widestring;
AShowInTree : Boolean) : IServerDocument;
Description
CreateDocumentShowOrHide 関数は、作成されたドキュメントが Altium Designer でどのように表示されるかを制御します。
Example

See also
IServerModule インターフェース

プロパティ

Client プロパティ

(IServerModule インターフェース)
Syntax
Property Client : IClient Read GetClient;
Description
Client プロパティは、Altium Designer のクライアントサブシステムの IClient インターフェースを返します。この IClient インターフェースを使用して、そのメソッドを呼び出せます。
この読み取り専用プロパティは GetClient メソッドでサポートされます。
Example

See also
IServerModule インターフェース

CommandLauncher プロパティ

(IServerModule インターフェース)
Syntax
Property CommandLauncher : ICommandLauncher Read GetCommandLauncher;
Description
CommandLauncher プロパティは、ICommandLauncher インターフェースへのポインターを返します。これは、サーバーモジュールからプロセスを起動するために使用されます。CommandLauncher オブジェクトにはコマンドテーブルが含まれており、プロセス名を、実行時にそのプロセスを実装する実際の関数に関連付けます。
サーバー内でプロセスが呼び出されるたびに、このテーブルが参照され、実際の関数ポインターが検索されます。プロセス名がこのテーブル内に見つからない場合は、何も実行されません。
この CommandLauncher オブジェクトは、サーバープロジェクトの main.pas ユニットで初期化されます。詳細は ICommandLauncher インターフェースを参照してください。
この読み取り専用プロパティは GetCommandLauncher メソッドでサポートされます。
Example

See also
IServerModule インターフェース

DocumentCount プロパティ

(IServerModule インターフェース)
Syntax
Property DocumentCount : Integer Read GetDocumentCount;
Description
DocumentCount プロパティは、Document Kind の数を返します。重要な点として、View は実際の設計ドキュメントです。Document タイプは、特定の View を格納するコンテナーです。
このプロパティは GetDocumentCount メソッドでサポートされます。
Example

See also
IServerModule インターフェース

Documents プロパティ

(IDocuments インターフェース)
Syntax
Property Documents Integer : IServerDocument Read GetDocuments;
Description
エディタータイプのサーバーは、Schematic Editor や PCB Editor など、異なるドキュメントタイプを持つことができます。これらのエディターサーバーには、それぞれ 2 つのドキュメントタイプ、すなわち SCH/SCHLIB および PCB/PCBLIB があります。
アドオンタイプのサーバーは通常、ドキュメントコンテナーを持ちません。これは、エディターサーバーに付随して動作し、そのエディターサーバーの API サービスを利用するためです。
このプロパティは、IServerDocument インターフェースで表されるインデックス付きドキュメントコンテナーを返します。
この読み取り専用プロパティは GetDocuments メソッドでサポートされます。
Example

See also
IClient インターフェース
IServerModule インターフェース
DocumentCount プロパティ

Handl e プロパティ

(IServerModule インターフェース)
Syntax
Property Handle : THandle Read GetHandle;
Description
Handle プロパティはサーバーのハンドルを返します。この読み取り専用プロパティは GetHandle メソッドでサポートされます。
Example

See also
IServerModule インターフェース

ModuleName プロパティ

(IServerModule インターフェース)
Syntax
Property ModuleName : Widestring Read GetModuleName;
Description
ModuleName プロパティは、このサーバーのモジュール名を返します。
たとえば、Texteditor サーバーのモジュール名は TextEdit です。このサーバー名プロパティは、関連するサーバーインストールファイル（拡張子 INS のファイル）で定義されます。
この読み取り専用プロパティは GetModuleName メソッドでサポートされます。
Example

If  StringsEqual(ServerModule.ModuleName,'TextEdit')  Then
Begin
...
End;

See also
IServerModule インターフェース

ProcessControl プロパティ

(IServerModule インターフェース)
Syntax
Property ProcessControl : IProcessControl Read GetProcessControl;
Description
ProcessControl プロパティは、IProcessControl インターフェースへのポインターを返します。このインターフェースは、Altium Designer の各設計ドキュメントに対するプロセス深度を制御します。
ドキュメント上でプロセスが起動されるたびに、プロセス深度は 1 増加し、その同じプロセスの実行が終了すると 1 減少します。プロセス深度がゼロのとき、現在の設計ドキュメント上では何も行われていないことを示します。
この読み取り専用プロパティは GetProcessControl メソッドでサポートされます。
Example

See also
IServerModule インターフェース

ViewCount プロパティ

(IServerModule インターフェース)
Syntax
Property ViewCount : Integer Read GetViewCount;
Description
ViewCount プロパティは、指定されたサーバーのビュー数を返します。
View オブジェクトは、通常は関連サーバーがサポートするグローバルパネルとして、Altium Designer 内のフォーム/ウィンドウオブジェクトをカプセル化します。
この読み取り専用プロパティは GetViewCount メソッドでサポートされます。
Example

See also
IServerModule インターフェース

Views プロパティ

(IServerModule インターフェース)
Syntax
Property Views Integer : IServerView Read GetViews;
Description
Views プロパティは ViewCount プロパティと組み合わせることで、インデックス付き View オブジェクトを返します。View は、関連サーバーがサポートするフォームです。
この読み取り専用プロパティは GetViews メソッドでサポートされます。
Example

See also
IClient インターフェース
IServerModule インターフェース

ドキュメントおよびパネルビューのインターフェース

IExternalForm インターフェース

Overview
IExternalForm インターフェースは、Delphi フォームをドキュメントフォームまたはパネルフォームとして表します。この IExternalForm インターフェースオブジェクトには、フォームのサイズ変更や表示などの低レベルメソッドがあります。
Notes
Altium Designer プラットフォームは Borland(TM) のオブジェクトインターフェース技術に基づいています。そのため、TForm、TFrame、およびその他の VCL コントロールのオブジェクトインターフェースは、異なるプログラミングシステムでのサードパーティ開発向けに公開できるオブジェクトインターフェースには渡されません。たとえば、VCL 技術は MS C++ ツールキットと互換性がありません。
したがって、Altium Designer プラットフォームでウィンドウを扱うには、IExternalForm インターフェースを使用してウィンドウにアクセスし、それらを操作します。IExternalFormHolder インターフェースおよび TExternalFormComponent クラスは、Altium Designer プラットフォームにプラグインされたサーバー内の Delphi ウィンドウを扱い、さらにプラグインされた他のサーバーからアクセス可能にするために使用されます。
IExternalForm Methods and Properties Table

See also
IServerView インターフェース
IServerDocumentView インターフェース
IExternalFormHolder インターフェース
ExternalForm ユニットの TExternalFormComponent クラス
ExternalForm ユニットの TServerExternalFormComponent クラス。

IExternalForm のメソッド

FocusFirstTabStop メソッド

(IExternalForm インターフェース)
Syntax
Procedure FocusFirstTabStop;
Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

GetBounds メソッド

(IExternalForm インターフェース)
Syntax
Procedure GetBounds (Var ALeft, ATop, AWidth, AHeight : Integer);
Description
このプロシージャは、フォームの 4 つの境界値（left、top、width、height）を取得します。
Example

See also
IClient インターフェース
IExternalForm インターフェース

Hide メソッド

(IExternalForm インターフェース)
Syntax
Procedure Hide;
Description
この Hide メソッドは、Altium Designer の表示からフォームを隠します。
Example

See also
IClient インターフェース
IExternalForm インターフェース

ParentWindowCreated メソッド

(IExternalForm インターフェース)
Syntax
Procedure ParentWindowCreated;
Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

ParentWindowDestroyed メソッド

(IExternalForm インターフェース)
Syntax
Procedure ParentWindowDestroyed;
Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

SetBounds メソッド

(IExternalForm インターフェース)
Syntax
Procedure SetBounds (ALeft(IExternalForm インターフェース)
Syntax
Procedure Show;
Description
このプロシージャは、非表示のフォームを表示します。
Example

See also
IClient インターフェース
IExternalForm インターフェース

IExternalForm のプロパティ

Caption プロパティ

(IExternalForm インターフェース)
Syntax
Property Caption : Widestring
Description
この読み取り専用プロパティは、このダイアログに関連付けられた外部フォームのキャプションを返します。
Example

See also
IClient インターフェース
IExternalForm インターフェース

Handle プロパティ

(IExternalForm インターフェース)
Syntax
Property Handle : HWND
Description
この読み取り専用プロパティは、Delphi ベースのフォームのハンドルを返します。
Example

See also
IClient インターフェース
IExternalForm インターフェース

IExternalFormHolder インターフェース

Overview
IExternalFormHolder インターフェースは TExternalFormComponent オブジェクトを表し、IExternalForm インターフェースを保持します。
Notes
DXP プラットフォームは Borland(TM) のオブジェクトインターフェース技術に基づいています。そのため、TForm、TFrame、およびその他の VCL コントロールのオブジェクトインターフェースは、異なるプログラミングシステムでのサードパーティ開発向けに公開できるオブジェクトインターフェースへは受け渡されません。たとえば、VCL 技術は MS C++ toolkit と互換性がありません。
したがって、Altium Designer プラットフォームでウィンドウを扱うには、IExternalForm インターフェースを使用してウィンドウへアクセスし、それらを操作します。IExternalFormHolder インターフェースと TExternalFormComponent クラスは、Altium Designer プラットフォームにプラグインされたサーバー内で Delphi ウィンドウを操作するために使用されます。
IExternalFormHolder Methods and Properties Table

See also
IExternalForm インターフェース
ExternalForm ユニット内の TExternalFormComponent クラス。

IExternalFormHolder のメソッド

GetParentWindow メソッド

(IExternalFormHolder インターフェース)
Syntax
Function GetParentWindow : THandle;
Description
この関数は、IExternalForm インターフェースで使用できる親ウィンドウの THandle を取得します。
Example

See also
IExternalFormHolder インターフェース

SetDialogHandle メソッド

(IExternalFormHolder インターフェース)
Syntax
Procedure SetDialogHandle (AHandle : THandle);
Description
このプロシージャは、この外部フォームのダイアログハンドルを設定します。
Example

See also
IExternalFormHolder インターフェース

IHTMLViewExternalForm インターフェース

Overview
The I HTMLViewExternalForm インターフェースは HTML ドキュメントを表します。

ISceneView インターフェース

Overview
ISceneView インターフェースは特定のビューを表します。

INavigationDocument インターフェース

Overview
INavigationDocument インターフェースは特定のナビゲーションビューを表します。

See also
IExternalForm インターフェース

IServerView インターフェース

Overview
IServerView インターフェースは、ドキュメントまたはパネルビューのオブジェクトインターフェースの祖先インターフェースです。
この IServerView インターフェースは、Altium Designer 内のグローバルパネルも表します。たとえば、Messages パネルや ToDo パネルなどです。

IServerView インターフェースの階層は次のとおりです。
IExternalForm
IServerView インターフェース
IServerView Methods and Properties Table

See also
IExternalForm インターフェース
IServerDocumentView インターフェース
IServerDocument インターフェース

IServerView の GetState および SetState メソッド

GetIsPanel メソッド

(IServerView インターフェース)
Syntax
Function GetIsPanel : LongBool;
Description
IsPanel プロパティは、IServerDocumentView オブジェクトがパネルかどうかを判定します。IServerDocument コンテナは IServerDocumentView オブジェクトを格納し、それらはパネルビューまたはドキュメントビューのいずれかです。
このプロパティは GetIsPanel メソッドによってサポートされます。
Example
Var
ServerDocumentView : IServerDocumentView;
Begin
ServerDocumentView := ServerDocument.View;
If Not(ServerDocumentView.IsPanel) Then
ShowMessage('Document Name ' + ServerDocument.FileName);
End;
See also
IClient インターフェース
IExternalForm インターフェース

GetViewName メソッド

(IServerView インターフェース)
Syntax
Function GetViewName : Widestring;
Description
ViewName プロパティはビュー名を表し、ドキュメントのファイル名とは異なります。ビューは、Altium Designer 全体で表示されるグローバルパネル、ドキュメントビュー、またはパネルビューのいずれかです。
この読み取り専用プロパティは GetViewName メソッドによってサポートされます。
たとえば、Altium Designer で開いているライブラリドキュメントでは、次の情報が得られます。
View Name: PCBEditor
Document Name: C:\Program Files\Altium Designer\Examples\Reference Designs\4 Port Serial Interface\Libraries\4 Port Serial Interface.PcbLib
Caption: PCBView_GraphicalForm

ViewName example

If  StrPas(Client.CurrentView.GetViewName)  <>  UpperCase('PCBLib')  Then  Exit;

このコードスニペットは、Client.CurrentView.ViewName メソッドを使用して現在のドキュメントのタイプ名を調べます。
See also
IClient インターフェース
IServerView インターフェース
IExternalForm インターフェース

IServerView のメソッド

GetViewState メソッド

(IServerView インターフェース)
Syntax
Function GetViewState : Widestring;
Description

Example

See also
IClient インターフェース
IServerView インターフェース
SetViewState メソッド

ReceiveNotification メソッド

(IServerView インターフェース)
Syntax
Procedure ReceiveNotification (Const ANotification : INotification);
Description
ReceiveNotification プロシージャは、Altium Designer によって生成された通知を取得します。グローバルパネル、ドキュメントビュー、またはパネルビューは、通知をインターセプトして、それに応じた処理を行うことができます。
Example

See also
IClient インターフェース
IServerView インターフェース
INotification インターフェース

SetViewState メソッド

(IServerView インターフェース)
Syntax
Procedure SetViewState(Const Astate : Widestring);
Description

Example

See also
IClient インターフェース
IExternalForm インターフェース
GetViewState メソッド

IServerView のプロパティ

IsPanel プロパティ

(IServerView インターフェース)
Syntax
Property IsPanel : LongBool Read GetIsPanel;
Description
IsPanel プロパティは、そのビューがパネルかドキュメントビューかを示すブール値を返します。
1 つのドキュメントは、1 つのドキュメントビューと少なくとも 1 つのパネルビューで構成されます。また、グローバルパネルビューである Message パネルのようなグローバルビューやシステムビューが存在する場合もあります。
この読み取り専用プロパティは GetIsPanel メソッドによってサポートされます。
Example

Var
ServerDocumentView  :  IServerDocumentView;
Begin
ServerDocumentView  :=  ServerDocument.View[j];
If  Not(ServerDocumentView.IsPanel)  Then  
  ShowMessage('Document  Name  '  +  ServerDocument.FileName);
End;

See also
IServerView インターフェース

ViewName プロパティ

(IServerView インターフェース)
Syntax
Property ViewName : Widestring Read GetViewName;
Description
ViewName プロパティはビュー名を表し、ドキュメントのファイル名とは異なります。ビューは、Altium Designer 全体で表示されるグローバルパネル、ドキュメントビュー、またはパネルビューのいずれかです。
この読み取り専用プロパティは GetViewName メソッドによってサポートされます。
たとえば、Altium Designer で開いているライブラリドキュメントでは、次の情報が得られます。
View Name: PCBEditor
Document Name: C:\Program Files\Altium Designer\Examples\Reference Designs\4 Port Serial Interface\Libraries\4 Port Serial Interface.PcbLib
Caption: PCBView_GraphicalForm
ViewName example
If StrPas(Client.CurrentView.ViewName) <> UpperCase('PCBLib') Then Exit;
このコードスニペットは、Client.CurrentView.ViewName メソッドを使用して現在のドキュメントの種類を調べます。
See also
IClient インターフェース
IServerView インターフェース

IServerDocumentView インターフェース

Overview
IServerDocumentView は、Altium Designer におけるドキュメントビュー、または関連付けられたパネルビューのいずれかを表します。このインターフェースは IServerView インターフェースから継承されています。
IServerDocument インターフェースは IServerDocumentView インターフェースを含みます。つまり、Altium Designer で開いている設計ドキュメントには、ドキュメントビューと少なくとも 1 つのパネルビューへのリンクが含まれています。

階層は次のとおりです。
IExternalForm
IServerView インターフェース
IServerDocumentView インターフェース

IServerDocumentView Methods and Properties Table

See also
IClient インターフェース
IServerModule インターフェース
IServerDocument インターフェース
IServerView インターフェース
IExternalForm インターフェース

IServerDocumentView の GetState および SetState メソッド

GetOwnerDocument メソッド

(IServerDocumentView インターフェース)
Syntax
Function GetOwnerDocument : IServerDocument;
Description
OwnerDocument プロパティは、この IServerDocumentView interface に関連付けられた IServerDocument インターフェースを返します。IServerDocument コンテナは、ドキュメントビューまたはパネルビューを表す IServerDocumentView インターフェースを格納します。
この読み取り専用プロパティは GetOwnerDocument メソッドによってサポートされます。
Example

See also
IClient インターフェース
IServerDocumentView インターフェース

IServerDocumentView のメソッド

PerformAutoZoom メソッド

(IServerDocumentView インターフェース)
Syntax
Procedure PerformAutoZoom;
Description
このプロシージャは、ドキュメントビュー / パネルビューの更新または再描画を強制します。
Example

See also
IClient インターフェース
IServerDocumentView インターフェース

UpdateStatusBar メソッド

(IServerDocumentView インターフェース)
Syntax
Procedure UpdateStatusBar;
Description
このプロシージャは、ステータスバーに文字列が送信されたときに、ステータスバーの更新を強制します。
Example

See also
IClient インターフェース
IServerDocumentView インターフェース

IServerDocumentView のプロパティ

OwnerDocument プロパティ

(IServerDocumentView インターフェース)
Syntax
Property OwnerDocument : IServerDocument Read GetOwnerDocument;
Description
このプロパティは、この IServerDocumentView インターフェースに関連付けられた IServerDocument インターフェースを返します。IServerDocument コンテナは、ドキュメントビューまたはパネルビューを表す IServerDocumentView インターフェースを格納します。
この読み取り専用プロパティは GetOwnerDocument メソッドによってサポートされます。
Example

See also
IClient インターフェース
IExternalForm インターフェース

IServerDocument インターフェース

Overview
IServerDocument インターフェースは、ドキュメントコンテナを表します。各 IServerDocument インターフェースは、同種のビューで構成 AddView
SetModified
SetIsShown
SetBeingClosed
Focus
DoFileLoad
DoFileSave
SupportsReload
GetCanClose
GetCount
GetFileName
SetFileName
GetKind
GetModified
GetIsShown
GetBeingClosed
GetFileModifiedDate
UpdateModifiedDate
GetServerModule
GetView
GetViewByName
NotifyViews
GetSupportsOwnSave
GetContextHelpTopicName
SetFileModifiedDate
WarnIfOwnedByOther
AcquireFileOwnership
ReleaseFileOwnership
ReleaseDataFileHandle
AcquireDataFileHandle
OwnsFile
DoSafeFileSave
DoSafeChangeFileNameAndSave
CreateSnippetFile
ZoomSnippetContents
GetSnippetView
PlaceSnippet
CanPlaceSnippet
CanCreateSnippet

IServerDocument
properties
CanClose
Count
FileName
Kind
Modified
IsShown
BeingClosed
ServerModule
View
SupportsOwnSave

IServerDocument example

Procedure  OpenAndShowADocument(Filename  :  TDynamicString);
Var
  ReportDocument  :  IServerDocument;
Begin
  If  Client  =  Nil  Then  Exit;
  ReportDocument  :=  Client.OpenDocument('Text',FileName);
  If  ReportDocument  <>  Nil  Then
  Client.ShowDocument(ReportDocument);
End;

See also
IClient インターフェース
IServerDocumentView インターフェース
IServerView インターフェース
\Developer Kit\Examples\DXP\ClientServer Interfaces\ フォルダー内の CS サーバーのサンプル。

IServerDocument メソッド

AddView メソッド

(IServerDocument インターフェース)
Syntax
Procedure AddView (Const AView : IServerDocumentView);
Description
このプロシージャは、サーバードキュメント内に IServerDocumentView オブジェクトを追加します。IServerDocument オブジェクトは、ドキュメントビューおよびパネルビューのビューを含むコンテナーです。
Example

See also
IServerDocument インターフェース
IServerDocumentView インターフェース

DoFileLoad メソッド

(IServerDocument インターフェース)
Syntax
Function DoFileLoad : LongBool;
Description
この関数は、ドキュメントの再読み込みを可能にします。ドキュメントが変更されて保存された後、ドキュメントが最新の状態であることを保証するために再読み込みが必要な場合に有用です。
Example

See also
IServerDocument インターフェース

DoFileSave メソッド

(IServerDocument インターフェース)
Syntax
Function DoFileSave (Const AKind : Widestring) : LongBool;
Description
この関数は、特定のドキュメントエディターが既定形式以外の別形式での保存オプションを提供している場合に、ドキュメントを別の形式で保存するためのオプションを提供します。通常、これらのファイル形式は、サーバーのインストールファイル（拡張子 INS）内の EditorWindowKind セクションにある SaveFilters ブロックに保存されています。
File Formats
たとえば、Altium Designer の PCB ドキュメントでは、PCB ASCII 形式、PCB Binary 3 形式などで保存できます。具体的には PCB Binary、PCB 3.0 Binary、PCB 4.0 Binary、PCB ASCII があり、既定では PCB Binary 5.0 です。
Schematic ドキュメントでは、Advanced Schematic binary、Advanced Schematic ascii、Schematic binary 4.0、Orcad SDT Schematic、Advanced Schematic template として保存できます。

Server Installation files
エディターでサポートされるファイル形式は、サーバーのインストールファイル内の SaveFilters - End ブロックで確認できます。

DelphiScript Example

Var
  Board  :  IPCB_Document;
  AView  :  IServerDocumentView;
  AServerDocument  :  IServerDocument;
Begin
  //  save  the  file  in  a  different  PCB  format
  //check  if  current  document  is  a  PCB  document  otherwise  exit!
  Board  :=  PCBServer.GetCurrentPCBBoard;
  If  Board  =  Nil  Then  Exit;
  If  Client  =  Nil  Then  Exit;

  //  Grab  the  current  document  view  using  the  Client's  Interface.
  AView  :=  Client.GetCurrentView;
  AServerDocument  :=  AView.OwnerDocument;
  AServerDocument.DoFileSave('PCB  ASCII');
  Close;
End;

See also
IServerDocument インターフェース
IServerDocument インターフェース
GetCanClose メソッド
GetModified メソッド
GetFileName メソッド

Focus メソッド

(IServerDocument インターフェース)
Syntax
Procedure Focus;
Description
このプロシージャは、ドキュメントを Altium Designer でフォーカスされたドキュメントに強制的に設定します。フォーカスされたドキュメントとは、Altium Designer のワークスペース内で最上位にあり、表示されていて、コマンドなどに応答するドキュメントです。
Example

See also
IServerDocument インターフェース

GetBeingClosed メソッド

(IServerDocument インターフェース)
Syntax
Function GetBeingClosed : LongBool;
Description
この関数は、サーバードキュメントが閉じられつつあるかどうかを判定します。ドキュメントを閉じられるかどうかの確認には GetCanClose 関数を使用してください。
Example

See also
IServerDocument インターフェース
GetCanClose メソッド
GetModified メソッド
GetFileName メソッド
DoFileSave メソッド

GetCanClose メソッド

(IServerDocument インターフェース)
Syntax
Function GetCanClose : LongBool;
Description
この関数は、ドキュメントを閉じられるかどうかを確認します。このメソッドは CanClose プロパティに使用されます。
Example

See also
IServerDocument インターフェース
GetModified メソッド
GetFileName メソッド
DoFileSave メソッド

GetContextHelpTopicName メソッド

(IServerDocument インターフェース)
Syntax
Function GetContextHelpTopicName : Widestring;
Description
GetContextHelpTopicName 関数は、ドキュメントのヘルプトピック名を取得します。通常、返される文字列は ServerModuleName.DocumentKind 形式で、たとえば 'SCH.SCH' のようになります。サーバーによっては、より詳細な情報を提供するものもあります。たとえば Schematic Editor サーバーは、回路図シート上でマウスが Port オブジェクトの上にある場合に Sch.Sheet.Port を返します。
Notes
サードパーティ開発者は、この関数を使用してコンテキスト依存ヘルプを提供できます。
サーバー用のヘルプを実装するには、Help フォルダー内に .HELPID ファイルを用意し、GetContextHelpTopicName が返す文字列と実際のヘルプドキュメントとの対応付けを定義する必要があります。
たとえば、CXTSystemDesignCapture.HelpID には Sch.Sheet.Port = CXTSystemDesignCapture.chm,Document_Objects\Port.htm が含まれます。これは、F1 キーが押されて Sch.Sheet.Port 文字列が返されたときに、CXTSystemDesignCapture.chm ファイル名が使用され、Document_Objects\Port.htm トピックが表示されることを意味します。
Example

See also
IServerDocument インターフェース

GetCount メソッド

(IServerDocument インターフェース)
Syntax
Function GetCount : Integer;
Description
Count プロパティは、IServerDocument コンテナー内のビュー（同じ型）の数を返します。View プロパティと組み合わせて使用してください。
このメソッドは Count プロパティに使用されます。
Example

Var
  ServerModule  :  IServerModule;
  ServerDocument  :  IServerDocument;
  ServerDocumentView  :  IServerDocumentView;
Begin
ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;
  
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  ServerDocument  :=  ServerModule.Documents[I];
  ShowMessage('Document  View  Count  '  +  
  IntToStr(ServerDocument.Count)  +  #13  +
  'Kind  '  +  ServerDocument.Kind));
End;
End;

See also
IServerDocument インターフェース

GetFileModifiedDate メソッド

(IServerDocument インターフェース)
Syntax
Function GetFileModifiedDate: TDateTime;
Description
この関数は、変更されたファイルの日付と時刻を返します。
Example

See also
IServerDocument インターフェース
GetFileModifiedDate メソッド
SetFileModifiedDate メソッド
Borland Delphi Run Time Library の TDateTime 型。

GetFileName メソッド

(IServerDocument インターフェース)
Syntax
Function GetFileName : Widestring;
Description
この関数は、サーバードキュメントのファイル名を文字列として取得します。サーバードキュメントはドキュメントビューまたはパネルビューのいずれかであり、パネルビューである場合は GetFileName メソッドは無効である点に注意してください。
Example

ServerDocumentView  :=  ServerDocument.View[j];
If  Not(ServerDocumentView.IsPanel)  Then  
  ShowMessage('  Document  Name  '  +  
  ServerDocument.FileName);

See also
IServerDocument インターフェース

GetIsShown メソッド

(IServerDocument インターフェース)
Syntax
Function GetIsShown : LongBool;
Description
IsShown プロパティは、このドキュメントが Altium Designer に表示されているかどうかを示します。このプロパティは GetIsShown および SetIsShown メソッドでサポートされます。
Example

See also
IServerDocument インターフェース

GetKind メソッド

(IServerDocument インターフェース)
Syntax
Function GetKind : Widestring;
Description
この関数は、このドキュメントの Kind 文字列を返し、Kind プロパティに使用されます。例としては 'PCB'、'PCBLIB'、'SCH'、'SCHLIB' などがあります。

Example

ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;
  
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  ServerDocument  :=  ServerModule.Documents[I];
  ShowMessage('Document  View  Count  '  +  
  IntToStr(ServerDocument.Count)  +  #13  +
  'Kind  '  +  ServerDocument.GetKind));
End;

See also
IServerDocument インターフェース

GetModified メソッド

(IServerDocument インターフェース)
Syntax
Function GetModified : LongBool;
Description
Modified プロパティは、このドキュメントが変更されているかどうかを示し、「dirty」フラグ、すなわちドキュメントが変更されて変更済みとしてマークされている状態と見なすことができます。
このプロパティは GetModified および SetModified メソッドでサポートされます。
Example

Var
  AView  :  IServerDocumentView;
  AServerDocument  :  IServerDocument;
Begin
  If  Client  =  Nil  Then  Exit;
  //  Grab  the  current  document  view  using  the  Client's  Interface.
  AView  :=  Client.GetCurrentView;

  //  Grab  the  server  document  which  stores  views  by  extracting  the  ownerdocument  field.
  AServerDocument  :=  AView.OwnerDocument;

  //  Set  the  document  dirty.
  AServerDocument.Modified  :=  True;
End;

See also
IServerDocument インターフェース

GetServerModule メソッド

(IServerDocument インターフェース)
Syntax
Function GetServerModule : IServerModule;
Description
ServerModule は読み取り専用プロパティで、このドキュメントに関連付けられた IServerModule インターフェースを返します。サーバーモジュールは、Altium Designer にインストールされ実行されているサーバーオブジェクトを表します。
サーバーモジュールは、自身のドキュメントとパネルを管理します。このプロパティは GetServerModule メソッドでサポートされます。
Example

//IServerModule  interface
ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;

ShowMessage(IntToStr(ServerModule.DocumentCount));
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  //IServerDocument  interface
  ServerDocument  :=  ServerModule.Documents[I];
  //  do  what  you  want  with  server  documents
End;

See also
IServerDocument インターフェース
IServerModule インターフェース

GetSupportsOwnSave メソッド

(IServerDocument インターフェース)
Syntax
Function GetSupportsOwnSave : LongBool;
Description
SupportsOwnSave プロパティは、サーバーに関連付けられたこれらのドキュメントを保存するための保存ルーチンが提供されているかどうかを示すブール値を返します。これは読み取り専用プロパティであり、GetSupportsOwnSave メソッドでサポートされます。
Example

See also
IServerDocument インターフェース

GetView メソッド

(IServerDocument インターフェース)
Syntax
Function GetView (Index : Integer) : IServerDocumentView;

Description
View プロパティはインデックス付きプロパティで、ドキュメントビューまたはパネルビューを表します。IServerDocument.Count メソッドは、IServerDocument コンテナーの一部としてビュー（ドキュメントウィンドウまたはパネルウィンドウ）の一覧を返します。
このプロパティは GetView メソッドでサポートされます。

Example

For  J  :=  0  to  ServerDocument.Count  -  1  Do
Begin
  ServerDocumentView  :=  ServerDocument.View[j];
  ShowMessage('View  Name  '  +  ServerDocumentView.ViewName);

  If  Not(ServerDocumentView.IsPanel)  Then  
  ShowMessage('  Document  Name  '  +
  ServerDocument.FileName);
End;

See also
IServerDocument インターフェース

GetViewByName メソッド

(IServerDocument インターフェース)
Syntax
Function GetViewByName (Const ViewName : Widestring) : IServerDocumentView;
Description
GetViewByName 関数は、ドキュメントビューまたはパネルビューを表す View オブジェクトを返します。
Example

ServerDocumentView  :=  ServerDocument.GetViewByName(PCBExpressionFilter);
If  ServerDocumentView.IsPanel  Then  
  ShowMessage('This  Server  Document  View  is  a  Panel');

See also
IServerDocument インターフェース
IServerDocumentView インターフェース

SetBeingClosed メソッド

(IServerDocument インターフェース)
Syntax
Procedure SetBeingClosed (Const Value : LongBool);
Description
BeingClosed プロパティは、この設計ドキュメントが正常に破棄される前に閉じられつつあることを示します。このプロパティは読み取り専用プロパティです。ドキュメントが閉じられる前にドキュメントを変更または更新しようとする場合は、その前にドキュメントの状態を確認できます。
このプロパティは GetBeingClosed および SetBeingClosed メソッドでサポートされます。
Example

See also
IServerDocument インターフェース

SetFileModifiedDate メソッド

(IServerDocument インターフェース)
Syntax
Procedure SetFileModifiedDate(Const AValue : TDateTime);
Description
このプロシージャは、ドキュメントが外部要因によって変更された場合に、そのドキュメントの更新日時を設定します。
Example

See also
IServerDocument インターフェース
GetModified メソッド
SetModified メソッド
SetFileName メソッド
(IServerDocument インターフェース)
Syntax
Function SetFileName (Const AFileName : Widestring): Widestring;
Description
SetFileName 関数は、ドキュメントのファイル名を設定します。
Example

See also
IServerDocument インターフェース

SetIsShown メソッド

(IServerDocument インターフェース)
Syntax
Procedure SetIsShown (Const Value : LongBool);
Description
IsShown プロパティは、このドキュメントが Altium Designer に表示されているかどうかを示します。このプロパティは GetIsShown および SetIsShown メソッドでサポートされます(IServerDocument interface)
Syntax
Procedure SetModified (Const Value : LongBool);
Description
Modified プロパティは、このドキュメントが変更されているかどうかを示し、いわゆる "dirty" フラグとして扱えます。つまり、ドキュメントが変更され、dirty としてマークされていることを示します。
このプロパティは、GetModified メソッドおよび SetModified メソッドによってサポートされます。
Example

Var
  AView  :  IServerDocumentView;
  AServerDocument  :  IServerDocument;
Begin
  If  Client  =  Nil  Then  Exit;
  //  Grab  the  current  document  view  using  the  Client's  Interface.
  AView  :=  Client.GetCurrentView;

  //  Grab  the  server  document  which  stores  views  by  extracting  the  ownerdocument  field.
  AServerDocument  :=  AView.OwnerDocument;

  //  Set  the  document  dirty.
  AServerDocument.Modified  :=  True;
End;

See also
IServerDocument interface

NotifyViews method

(IServerDocument interface)
Syntax
Procedure NotifyViews (ANotification : INotification);
Description
このプロシージャは、IServerDocument コンテナに関連付けられたすべてのビューに通知を送信します。
Example

See also
IServerDocument interface
INotification interface

SupportsReload method

(IServerDocument interface)
Syntax
Function SupportsReload : LongBool;
Description
このメソッドは、Altium Designer 内のドキュメントを再読み込みできるかどうかを判定します（更新し、ドキュメントの状態が最新であることを確認するため）。
Example

See also
IServerDocument interface
DoFileLoad method

UpdateModifiedDate method

(IServerDocument interface)
Syntax
Procedure UpdateModifiedDate;
Description
このプロシージャは、このドキュメントが変更された後に、変更済みドキュメントの日付を更新します。
Example

See also
IServerDocument interface
GetModified method

SetModified method

ReleaseFileOwnership method

(IServerDocument interface)
Syntax
Procedure ReleaseFileOwnership;
Description
内部使用専用です。
Example

See also
IServerDocument interface

ReleaseDataFileHandle method

(IServerDocument interface)
Syntax
Procedure ReleaseDataFileHandle;
Description
内部使用専用です。
Example

See also
IServerDocument interface

OwnsFile method

(IServerDocument interface)
Syntax
Function OwnsFile : Boolean;
Description
OwnsFile 関数は、そのドキュメントが Altium Designer 製品によって所有されているかどうかを判定し、その結果としてこのドキュメントを保存できるかどうかを判断します。
Example

See also
IServerDocument interface

DoSafeFileSave method

(IServerDocument interface)
Syntax
Function DoSafeFileSave (Const AKind : Widestring) : LongBool;
Description
この関数は、指定されたドキュメントタイプのドキュメントを安全に保存できるかどうかを判定します。
Example

See also
IServerDocument interface

DoSafeChangeFileNameAndSave method

(IServerDocument interface)
Syntax
Function DoSafeChangeFileNameAndSave(Const ANewFileName, AKind : Widestring) : LongBool;
Description
この関数は、現在のドキュメントを新しいファイル名および新しいドキュメントタイプで保存できるかどうかを判定します。
Example

See also
IServerDocument interface

AcquireFileOwnership method

(IServerDocument interface)
Syntax
Procedure AcquireFileOwnership;
Description
内部使用専用です。
Example

See also
IServerDocument interface

AcquireDataFileHandle method

(IServerDocument interface)
Syntax
Procedure AcquireDataFileHandle;
Description
内部使用専用です。
Example

See also
IServerDocument interface

WarnIfOwnedByOther method

(IServerDocument interface)
Syntax
Function WarnIfOwnedByOther(AWarningLevel : TFileOwnershipWarningLevel) : LongBool;
Description
この関数は、そのドキュメントが他のユーザーによって所有されているかどうかを判定します。ドキュメントは他のユーザーと共有できますが、1 人のユーザーだけがそのドキュメントを単独所有している場合、他のユーザーはそのドキュメントを保存できません。
Example

See also
IServerDocument interface

IServerDocument Properties

BeingClosed property

(IServerDocument interface)
Syntax
Property BeingClosed : LongBool Read GetBeingClosed Write SetBeingClosed;
Description
BeingClosed プロパティは、この設計ドキュメントが正常に破棄される前に閉じられつつあることを示します。このプロパティは読み取り専用プロパティです。ドキュメントが閉じられる前に変更または更新を試みる前に、ドキュメントの状態を確認できます。
このプロパティは、GetBeingClosed メソッドおよび SetBeingClosed メソッドによってサポートされます。
Example

See also
IClient interface
IServerDocument interface

CanClose property

(IServerDocument interface)
Syntax
Property CanClose : LongBool Read GetCanClose;
Description
この CanClose プロパティは、ドキュメントを閉じることができるかどうかを判定します。
Example

See also
IClient interface
IServerDocument interface

Count property

(IServerDocument interface)
Syntax
Property Count : Integer Read GetCount;
Description
Count プロパティは、IServerDocument コンテナ内のビュー（同じタイプ）の数を返します。View プロパティと組み合わせて使用します。
このプロパティは GetCount メソッドによってサポートされます。
Example

Var
  ServerModule  :  IServerModule;
  ServerDocument  :  IServerDocument;
  ServerDocumentView  :  IServerDocumentView;
Begin
ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;
  
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  ServerDocument  :=  ServerModule.Documents[I];
  ShowMessage('Document  View  Count  '  +  
  IntToStr(ServerDocument.Count)  +  #13  +
  'Kind  '  +  ServerDocument.Kind));
End;
End;

See also
IClient interface
IServerDocument interface

Filename property

(IServerDocument interface)
Syntax
Property FileName : Widestring Read GetFileName;
Description
FileName プロパティは、サーバードキュメントのファイル名を返します（対応するサーバーパネルではありません）。このプロパティは読み取り専用プロパティであり、GetFileName メソッドによってサポートされます。
サーバードキュメントはドキュメントビューまたはパネルビューである可能性がある点に注意してください。したがって、パネルビューである場合、FileName プロパティは無効です。

Example

ServerDocumentView  :=  ServerDocument.View[j];
If  Not(ServerDocumentView.IsPanel)  Then  
  ShowMessage('  Document  Name  '  +  
  ServerDocument.FileName);

See also
IClient interface
IServerDocument interface

IsShown property

(IServerDocument interface)
Syntax
Property IsShown : LongBool Read GetIsShown Write SetIsShown;
Description
このプロパティは、このドキュメントが Altium Designer に表示されているかどうかを示します。このプロパティは、GetIsShown メソッドおよび SetIsShown メソッドによってサポートされます。
Example

See also
IClient interface
IServerDocument interface

Kind property

(IServerDocument interface)
Syntax
Property Kind : Widestring Read GetKind;
Description
Kind は、Altium Designer で開かれているドキュメントのタイプを示します。
例としては 'PCB'、'PCBLIB'、'SCH'、'SCHLIB' などがあります。このプロパティは読み取り専用プロパティです。このプロパティは GetKind メソッドによってサポートされます。
Example

ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;
  
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  ServerDocument  :=  ServerModule.Documents[I];
  ShowMessage('Document  View  Count  '  +  
  IntToStr(ServerDocument.Count)  +  #13  +
  'Kind  '  +  ServerDocument.Kind));
End;

See also
IClient interface
IServerDocument interface

Modified property

(IServerDocument interface)
Syntax
Property Modified : LongBool Read GetModified Write SetModified;
Description
Modified プロパティは、このドキュメントが変更されているかどうかを示し、いわゆる "dirty" フラグとして扱えます。つまり、ドキュメントが変更され、dirty としてマークされていることを示します。
このプロパティは、GetModified メソッドおよび SetModified メソッドによってサポートされます。
Example

Var
AView : IServerDocumentView;
AServerDocument : IServerDocument;
Begin
If Client = Nil Then Exit;
// Grab the current document view using the Client's Interface.
AView := Client.GetCurrentView;

// Grab the server document which stores views by extracting the ownerdocument field.
AServerDocument := AView.OwnerDocument;

// Set the document dirty.
AServerDocument.Modified := True;
End;

See also
IClient interface
IServerDocument interface

ServerModule property

(IServerDocument interface)
Syntax
Property ServerModule : IServerModule Read GetServerModule;
Description
ServerModule は読み取り専用プロパティで、このドキュメントに関連付けられている IServerModule インターフェースを返します。サーバーモジュールは、Altium Designer にインストールされ実行中のサーバーオブジェクトを表します。
サーバーモジュールは自身のドキュメントおよびパネルを管理します。このプロパティは GetServerModule メソッドによってサポートされます。
Example

//IServerModule  interface
ServerModule  :=  Client.ServerModuleByName['PCB'];
If  ServerModule  =  Nil  Then  Exit;

ShowMessage(IntToStr(ServerModule.DocumentCount));
For  I  :=  0  to  ServerModule.DocumentCount  -  1  Do
Begin
  //IServerDocument  interface
  ServerDocument  :=  ServerModule.Documents[I];
  //  do  what  you  want  with  server  documents
End;

See also
IClient interface
IServerDocument interface
IServerModule interface

SupportsOwnSave property

(IServerDocument interface)
Syntax
Property SupportsOwnSave : LongBool Read GetSupportsOwnSave;
Description
SupportsOwnSave プロパティは、サーバーに関連付けられたこれらのドキュメントを保存するための保存ルーチンが提供されているかどうかを示すブール値を返します。読み取り専用プロパティです。
Example

See also
IClient interface
IServerDocument interface

View property

(IServerDocument interface)
Syntax
Property View Integer : IServerDocumentView Read GetView;
Description
View プロパティはインデックス付きプロパティで、特定の IServerModule インターフェースに関連付けられた IDocument コンテナの一部であるドキュメントビューまたはパネルビューを表します。IServerDocument.Count メソッドは、IServerDocument コンテナの一部としてビュー（ドキュメントまたはパネルウィンドウの場合があります）の一覧を返します。
このプロパティは GetView メソッドによってサポートされます。
Example

For  J  :=  0  to  ServerDocument.Count  -  1  Do
Begin
  ServerDocumentView  :=  ServerDocument.View[j];
  ShowMessage('View  Name  '  +  ServerDocumentView.ViewName);

  If  Not(ServerDocumentView.IsPanel)  Then  
  ShowMessage('  Document  Name  '  +
  ServerDocument.FileName);
End;

See also
IClient interface
IServerDocument interface

IHighlightedDocument Interface

Overview
この IHighlightedDocument インターフェースは、Altium Designer において、オブジェクトが選択または選択解除されるとき、またマスクされるとき／されないときに、設計ドキュメント（特に回路図および PCB ドキュメント）上のオブジェクトのハイライトを処理するメカニズムを表します。
このインターフェースとそのメソッドは内部使用向けです。
Notes
The IHighlightedDocument interface is inherited from the IServerDocument interface.
IHighlightedDocument Methods and Properties Table

See also
IServerDocument interface

IServerPanelInfo Interface

Overview
IServerPanelInfo インターフェースは、Altium Designer におけるパネルの詳細をカプセル化します。詳細には、名前、ビットマップ、パネルを水平方向または垂直方向にドッキングできるかどうか、などが含まれます。
このインターフェースは、IServerRecord インターフェースおよび IClient インターフェースによって使用されます。

IServerPanelInfo Methods and Properties Table

See also
IServerRecord interface
IClient Interface

IServerPanelInfo Methods

GetBitmap method

(IServerPanelInfo interface)
Syntax
Function GetBitmap : Widestring;
Description
この関数はビットマップの名前を返します。
Example

See also
IServerPanelInfo interface

GetButtonVisible method

(IServerPanelInfo interface)
Syntax
Function GetButtonVisible : Boolean;
Description
この関数は、パネル上のボタンが表示されているかどうかを返します。
Example

See also
IServerPanelInfo interface

GetCanDockHorizontal method

(IServerPanelInfo interface)
Syntax
Function GetCanDockHorizontal: Boolean;
Description
この関数は、パネルを Altium Designer ユーザーインターフェースに水平方向でドッキングできるかどうかを判定します。
Example

See also
IServerPanelInfo interface

GetCanDockVertical method

(IServerPanelInfo interface)
Syntax
Function GetCanDockVertical : Boolean;
Description
この関数は、パネルを Altium Designer ユーザーインターフェースに垂直方向でドッキングできるかどうかを判定します。
Example

See also
IServerPanelInfo interface

GetCategory method

(IServerPanelInfo interface)
Syntax
Function GetCategory : Widestring;
Description
この関数は Category 文字列を返します。つまり、Altium Designer 内でどのモジュールの一部であるかを示します。たとえば、Favorites パネルは System の一部です。
Example

See also
IServerPanelInfo interface

GetCreationClassName method
Syntax
Function GetDocumentKindCount : Integer;
Description
この関数は、このパネルに関連付け可能なドキュメント種別の数を報告します。たとえば Simulation Breakpoints パネルは、VHDL および VHDTST ドキュメントに関連付けることができます。
この関数は GetDocumentKinds 関数と組み合わせて使用します。
Example

See also
IServerPanelInfo インターフェース

GetDocumentKinds メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetDocumentKinds(Index : Integer) : WideString;
Description
この関数は、このパネルに関連付けられている、インデックス指定された Document Kind 文字列を返します。たとえば Simulation Breakpoints パネルは、VHDL および VHDTST ドキュメントに関連付けることができます。この関数は GetDocumentKindCount 関数と併用します。
Example

See also
IServerPanelInfo インターフェース

GetHotkey メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetHotkey : Widestring;
Description
この関数は、パネルの表示／非表示を切り替えるために使用される HotKey 文字列を返します。
Example

See also
IServerPanelInfo インターフェース

GetMultipleCreation メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetMultipleCreation : Boolean;
Description
内部使用。
Example

See also
IServerPanelInfo インターフェース

GetName メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetName : Widestring;
Description
この関数はパネル名を返します。たとえば PCB Library パネルの名前は PCBLibPanel です。
Example

See also
IServerPanelInfo インターフェース

GetProjectKindCount メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetProjectKindCount : Integer;
Description
内部使用。
Example

See also
IServerPanelInfo インターフェース

GetProjectKinds メソッド

（IServerPanelInfo インターフェース）
Syntax
Function GetProjectKinds(Index : Integer) : WideString;
Description
内部使用。
Example

See also
IServerPanelInfo インターフェース

SupportsDocumentKind メソッド

（IServerPanelInfo インターフェース）
Syntax
Function SupportsDocumentKind(Const AKind : Widestring) : Boolean;
Description
この関数は、そのドキュメント種別がこのパネルでサポートされているかどうかを判定します。
Example

See also
IServerPanelInfo インターフェース

SupportsProjectKind メソッド

（IServerPanelInfo インターフェース）
Syntax
Function SupportsProjectKind (Const AKind : Widestring) : Boolean;
Description
内部使用。
Example

See also
IServerPanelInfo インターフェース

IServerPanelInfo プロパティ

DocumentKindCount プロパティ

（IServerPanelInfo インターフェース）
Syntax
Property DocumentKindCount : Integer read GetDocumentKindCount;
Description
このプロパティは、このパネルに関連付け可能なドキュメント種別の数を報告します。たとえば Simulation Breakpoints パネルは、VHDL および VHDTST ドキュメントに関連付けることができます。
このプロパティは DocumentKinds プロパティと組み合わせて使用します。
Example

See also
IServerPanelInfo インターフェース

DocumentKinds プロパティ

（IServerPanelInfo インターフェース）
Syntax
Property DocumentKinds Integer : WideString read GetDocumentKinds;
Description
このプロパティは、このパネルに関連付けられている、インデックス指定された Document Kind 文字列を返します。たとえば Simulation Breakpoints パネルは、VHDL および VHDTST ドキュメントに関連付けることができます。このプロパティは GetDocumentKindCount 関数と併用します。
Example

See also
IServerPanelInfo インターフェース

ProjectKindCount プロパティ

（IServerPanelInfo インターフェース）
Syntax
Property ProjectKindCount : Integer read GetProjectKindCount;
Description
内部使用
Example

See also
IServerPanelInfo インターフェース

ProjectKinds プロパティ

（IServerPanelInfo インターフェース）
Syntax
Property ProjectKinds Integer : WideString read GetProjectKinds;
Description
内部使用
Example

See also
IServerPanelInfo インターフェース

System Interfaces

ICommandLauncher インターフェース

Overview
ICommandLauncher インターフェースは、Altium Designer でコマンド（あらかじめパッケージ化されたプロセス）を起動する機能をカプセル化したものです。コマンドは、サーバー内のユーザーインターフェース項目（Text Editor、Schematic Editor など）に関連付けられており、たとえばホットキーボタン、メニュー項目、またはツールバーのビットマップなどがあります。要するに、サーバーはその一連のプロセスによって支えられており、それらのプロセスは Altium Designer とそのサーバーとの間のリンクとして機能します。
LaunchCommand メソッドは、この ICommandLauncher インターフェース関数に関連付けられたサーバーからプロセスを起動します。
GetCommandState メソッドは、指定されたコマンドの情報を取得します。
サーバーは一連のプロセスを持ち、それらのプロセス識別子はインストールファイル（拡張子は INS）に格納されます。また、特定のユーザーインターフェース要素（リソースとも呼ばれます）にリンクするプロセスランチャーと、ユーザーインターフェース要素のレイアウトはリソースファイル（拡張子は RCS）で定義されます。
ICommandLauncher Methods and Properties Table

Notes
プリミティブの配置、ズームレベルの変更など、サーバー内でユーザーが利用できるすべての機能は、あらかじめパッケージ化されたプロセスランチャーであるコマンドによって実行されます。これらの事前パッケージ済みプロセスランチャーには、コマンド選択時に実行されるプロセスに加えて、パラメータ、ビットマップ（アイコン）、キャプション（リソース上に表示される項目名）、説明、および関連するショートカットキーがまとめられています。
メニュー項目を選択したりツールバーボタンをクリックしたりすると、プロセスを起動していることになります。プロセスは、そのプロセス識別子を適切なサーバーに渡すことで起動され、サーバーがそのプロセスを実行します。プロセスはサーバーのソースコードプロジェクト内の Commands ユニットで定義・実装されます。プロセスはインストールファイル（拡張子 INS）で宣言されます。
各プロセスにはプロセス識別子があります。プロセス識別子はコロンで区切られた 2 つの部分で構成されます。最初の部分はそのプロセスを定義するサーバーを示し、2 番目の部分はプロセス名です。
たとえば、プロセス Sch:ZoomIn は Schematic サーバーによって提供されます。このプロセスが起動されると、メニュー項目の選択、ホットキーの押下、またはツールバーボタンの有効化（これらはいずれも Altium Designer ではプロセスランチャーとして定義されています）によって、現在アクティブな回路図シートを拡大表示する処理が実行されます。
サーバーが Altium Designer で初めて起動されると、そのサーバーモジュール内の CommandLauncher オブジェクトに登録されたプロセス手続きまたはコマンドが Altium Designer に読み込まれます。
See also
IClient インターフェース
IServerModule インターフェース

ICommandLauncher メソッド

GetCommandState

（ICommandLauncher インターフェース）
Syntax
Procedure GetCommandState( ACommandName,
AParameters : PChar;
Const AContext : IServerDocumentView;
Var Enabled,
Checked,
Visible : LongBool;
Caption,
ImageFile : PChar);
Description
GetCommandState プロシージャは、サーバーコマンド（内部サーバープロセス）の現在のスナップショットを取得し、指定されたサーバーコマンド名に対するパラメータを返します。
Example

ACommandLauncher  :=  AServerModule.GetCommandLauncher;
If  ACommandLauncher  <>  Nil  Then
Begin
  ACommandLauncher.GetCommandState(Command,
  Parameters,
  View,
  Enabled,
  Checked,
  Visible,
  Caption,
  Image);
  //  do  what  you  want  with  the  parameters  
  //  after  you  have  supplied  the  Command  parameter.
End;

See also
IServerModule インターフェース

LaunchCommand

（ICommandLauncher インターフェース）
Syntax
Function LaunchCommand (Const ACommandName : PChar;
AParameters : PChar;
MaxParameterSize : Integer;
AContext : IServerDocumentView) : LongBool;
Description
この関数は、サーバーモジュールまたは Client からコマンドを起動します。（Client も独自のプロセスを持つため、独自のコマンドランチャーテーブルを持ちます）。
AContext パラメータは、どの IServerDocumentView インターフェースに対してプロセスを起動するかを示します。コマンドを起動できる場合、この関数は true を返します。
Example

If  StringsEqual(ServerModule.ModuleName,'TextEdit')  Then
Begin
  ServerModule.CommandLauncher.LaunchCommand('TextEdit:MoveCursorToTopOfDocument',
  Nil,0,ServerDocument.View[0]);
End;

See also
IServerDocumentView インターフェース

IGUIManager インターフェース

Overview
IGUIManager インターフェースは、パネルのサイズ変更、特定のホットキーマップの確認、ステータスバーなど、Altium Designer アプリケーションのグラフィカルユーザーインターフェース部分を表します。

See also

IGUIManager メソッド

AddKeyStrokeAndLaunch メソッド

（IGUIManager インターフェース）
Syntax
Function AddKeyStrokeAndLaunch (AKey : Word) : LongBool;
Description

Example

See also
IGUIManager インターフェース

AddKeyToBuffer メソッド

（IGUIManager インターフェース）
Syntax
Function AddKeyToBuffer (KeyId : Integer;Alt, Shift, Ctrl : LongBool) : LongBool;
Description

Example

See also
IGUIManager インターフェース

BeginDragDrop メソッド

（IGUIManager インターフェース）
Syntax
Procedure BeginDragDrop (ADragDropInfo : IDragDropObject);
Description

Example

See also
IGUIManager インターフェース

CanResizePanel メソッド

（IGUIManager インターフェース）

Syntax
Function CanResizePanel (Const AViewName : Widestring) : LongBool;
Description
この関数は、パネルのサイズ変更が可能かどうかを判定します。パネル名を指定する必要があります。
Example

See also
IGUIManager インターフェース

CurrentProcessLauncherAvailable メソッド

（IGUIManager インターフェース）
Syntax
Function CurrentProcessLauncherAvailable : LongBool;
Description
この関数は、現在のプロセスランチャーが使用可能かどうかを判定します。
Example

See also
IGUIManager インターフェース

DoneTransparentToolbars メソッド

（IGUIManager インターフェース）
Syntax
Procedure DoneTransparentToolbars;
Description

Example

See also
IGUIManager インターフェース

GetActivePLByCommand メソッド

（IGUIManager インターフェース）
Syntax
Function GetActivePLByCommand (Const DocumentKind, ACommand, AParams : Widestring) : IProcessLauncherInfo;
Description

Example

See also
IGUIManager インターフェース

GetFocusedPanelName メソッド

（IGUIManager インターフェース）
Syntax
Function GetFocusedPanelName : Widestring;
Description

Example

See also
IGUIManager インターフェース

GetPanelIsOpen メソッド

（IGUIManager インターフェース）
Syntax
Function GetPanelIsOpen (Const AViewName : Widestring) : LongBool;
Description

Example

See also
IGUIManager インターフェース

GetProcessLauncherInfoByID メソッド

（IGUIManager インターフェース）
Syntax
Function GetProcessLauncherInfoByID (Const PLID : Widestring) : IProcessLauncherInfo;
Description

Example

See also
IGUIManager インターフェース

InitTransparentToolbars メソッド

（IGUIManager インターフェース）
Syntax
Procedure InitTransparentToolbars (Const ViewRect IGUIManager インターフェース

RegisterFloatingWindow メソッド

(IGUIManager インターフェース)
Syntax
Procedure RegisterFloatingWindow (Const FloatingWindow : IFloatingWindow);
Description

Example

See also
IGUIManager インターフェース

ResizePanel メソッド

(IGUIManager インターフェース)
Syntax
Procedure ResizePanel (Const AViewName : Widestring; AWidth, AHeight : Integer);
Description

Example

See also
IGUIManager インターフェース

SetFocusLock メソッド

(IGUIManager インターフェース)
Syntax
Procedure SetFocusLock (Locked : LongBool);
Description

Example

See also
IGUIManager インターフェース

SetPanelActiveInCurrentForm メソッド

(IGUIManager インターフェース)
Syntax
Procedure SetPanelActiveInCurrentForm (Const AViewName : Widestring);
Description

Example

See also
IGUIManager インターフェース

SetPanelVisibleInCurrentForm メソッド

(IGUIManager インターフェース)
Syntax
Procedure SetPanelVisibleInCurrentForm (Const AViewName : Widestring; IsVisible : LongBool);
Description

Example

See also
IGUIManager インターフェース

ShowCurrentProcessLauncherHelp メソッド

(IGUIManager インターフェース)
Syntax
Function ShowCurrentProcessLauncherHelp : LongBool;
Description

Example

See also
IGUIManager インターフェース

ShowTreeAsPopup メソッド

(IGUIManager インターフェース)
Syntax
Procedure ShowTreeAsPopup (Const TreeID : Widestring);
Description

Example

See also
IGUIManager インターフェース

StatusBar_GetState メソッド

(IGUIManager インターフェース)
Syntax
Function StatusBar_GetState (Index : Integer) : Widestring;
Description

Example

See also
IGUIManager インターフェース

StatusBar_SetState メソッド

(IGUIManager インターフェース)
Syntax
Procedure StatusBar_SetState (Index : Integer; Const S : Widestring);
Description

Example

See also
IGUIManager インターフェース

UnregisterFloatingWindow メソッド

(IGUIManager インターフェース)
Syntax
Procedure UnregisterFloatingWindow (Const FloatingWindow : IFloatingWindow);
Description

Example

See also
IGUIManager インターフェース

UpdateInterfaceState メソッド

(IGUIManager インターフェース)
Syntax
Procedure UpdateInterfaceState;
Description

Example

See also
IGUIManager インターフェース

UpdateTransparentToolbars メソッド

(IGUIManager インターフェース)
Syntax
Procedure UpdateTransparentToolbars;
Description

Example

See also
IGUIManager インターフェース

INavigationSystem インターフェース

Overview
ナビゲーションシステムは、設計プロジェクトのネット接続性の中心となる Navigation パネルの中核機能です。設計は、コンパイル済みシートのリスト、フラット化された階層構造、構造ツリーの3つの方法で配置できます。
INavigationSystem Methods and Properties Table

See also
IClient インターフェース

INavigationSystem メソッド

UnregisterNavigationProtocol メソッド

(INavigationSystem インターフェース)
Syntax
Procedure UnregisterNavigationProtocol(Const Protocol : WideString; Handle : THandle);
Description

Example

See also
INavigationSystem インターフェース

RegisterSpecialURLString メソッド

(INavigationSystem インターフェース)
Syntax
Procedure RegisterSpecialURLString (Const SpecialString : WideString; SpecialStringFunc : TSpecialStringFunc);
Description

Example

See also
INavigationSystem インターフェース

RegisterNavigationProvider メソッド

(INavigationSystem インターフェース)
Syntax
Function RegisterNavigationProvider (Const ProtocolName : WideString; Const NavigationProvider : INavigationProvider) : THandle;
Description

Example

See also
INavigationSystem インターフェース

ParseDestinationString メソッド

(INavigationSystem インターフェース)
Syntax
Procedure ParseDestinationString(Const Destination : WideString; Var Protocol, Target, Parameters : WideString);
Description

Example

See also
INavigationSystem インターフェース

NavigateTo メソッド

(INavigationSystem インターフェース)
Syntax
Function NavigateTo (Const CurrentView : IExternalForm; Var Destination : WideString; Out TargetView : IExternalForm) : LongBool;
Description

Example

See also
INavigationSystem インターフェース

ExpandTargets メソッド

(INavigationSystem インターフェース)
Syntax
Procedure ExpandTargets (Var Target : WideString);
Description

Example

See also
INavigationSystem インターフェース

ValidatedTarget メソッド

(INavigationSystem インターフェース)
Syntax
Function ValidatedTarget ( Target : WideString) : WideString;
Description

Example

See also
INavigationSystem インターフェース

UnregisterSpecialURLString メソッド

(INavigationSystem インターフェース)
Syntax
Procedure UnregisterSpecialURLString (Const SpecialString : WideString; SpecialStringFunc : TSpecialStringFunc);
Description

Example

See also
INavigationSystem インターフェース

INotification インターフェース

Overview
INotification インターフェースは、IClient、IServerView、IServerDocument、IServerModule、INotificationHandler の各インターフェースで使用されます。
通知には、ドキュメントの読み込み通知、ワークスペースの読み込み、オブジェクトへのナビゲーション、サーバーモジュールの読み込みなどがあります。
イベントメッセージとしての通知は Client システムによってブロードキャストでき、開いている任意のサーバードキュメントがそれを受信して、適切に処理できます。
Broadcast Notification はシステム全体の通知であり、Dispatch Notification はサーバー固有の通知です。

さまざまな種類の通知

1. DocumentNotification
2. ViewNotification
3. DocumentFormNotification
4. ModuleNotification
5. SystemNotification
6. MessagesNotification
7. DragDropNotification
8. FastCrossSelectNotification

サーバープロジェクトでの通知の設定

1. さまざまな通知を処理するために、TServerModule クラスの ReceiveNotifications メソッドをオーバーライドします。
2. 異なる通知ハンドラーを定義します。
3. 各通知の Code プロパティに基づいて各ハンドラーを処理します。

Example

Procedure  TNotificationModule.ReceiveNotification(Const  ANotification:  INotification);
Var
  DocumentNotification  :  IDocumentNotification;
  ViewNotification  :  IViewNotification;
  FormNotification  :  IDocumentFormNotification;
  ModuleNotification  :  IModuleNotification;
  SystemNotification  :  ISystemNotification;  
Begin
  If  Supports(ANotification,  IDocumentNotification,  DocumentNotification)  Then
  HandleDocumentNotification(DocumentNotification);

  If  Supports(ANotification,  IViewNotification,  ViewNotification)  Then
  HandleViewNotification(ViewNotification);

  If  Supports(ANotification,  IDocumentFormNotification,  FormNotification)  Then
  HandleFormNotification(FormNotification);

  If  Supports(ANotification,  IModuleNotification,  ModuleNotification)  Then
  HandleModuleNotification(ModuleNotification);

  If  Supports(ANotification,  ISystemNotification,  SystemNotification)  Then
  HandleSystemNotification(SystemNotification);
End;

INotification インターフェースの階層は次のとおりです。
INotification
IDocumentNotification
IViewNotification
IDocumentFormNotification
IModuleNotification
ISystemNotification
IMessageNotification
IDragDropNotification
IDocumentRequest
IFastCrossNotification

See also
IClient インターフェース
IServerView インターフェース
IServerDocument インターフェース
IServerModule インターフェース

INotificationHandler インターフェース

IDocumentNotification インターフェース
IViewNotification インターフェース
IDocumentFormNotification インターフェース
IModuleNotification インターフェース
ISystemNotification インターフェース
IMessageNotification インターフェース
IDragDropNotification インターフェース
IDocumentRequest インターフェース
IFastCrossNotification インターフェース

IDocumentFormNotification インターフェース

(IDocumentFormNotification インターフェース)
Overview

Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

ISystemNotification インターフェース

(ISystemNotification インターフェース)
Syntax

Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

IMessagesNotification インターフェース

Overview
IMessagesNotification インターフェース

See also
IClient インターフェース
IExternalForm インターフェース

IModuleNotification インターフェース

Overview

See also
IClient インターフェース
IExternalForm インターフェース

IViewNotification インターフェース

Overview

Description

Example

See also
IClient インターフェース
IExternalForm インターフェース

IDragDropNotification インターフェース

Overview

Notes
INotification インターフェースから継承されています。

See also
IDragDropObject インターフェース

IEventNavigated インターフェース

Overview

See also
IDragDropObject インターフェース

INavigationProvider インターフェース

Overview

See also
IDragDropObject インターフェース

INavigator インターフェース

Overview

See also

IBackForwardNavigator インターフェース

Overview

See also

INavigationSystem インターフェース

Overview

See also
IDragDropObject インターフェース

INavigateAttributes インターフェース

Overview

See also

IDynamicHelpManager インターフェース

Overview
このインターフェースは、Altium Designer の Knowledge Center パネルを表します。このインターフェースは IClient インターフェースの一部です。

See also
IClient インターフェース

IFastCrossSelectNotification インターフェース

Overview

See also
IClient インターフェース
IExternalForm インターフェース

IDocumentNotification インターフェース

Overview
IDocumentNotification インターフェースは、次を表します

See also
IClient インターフェース
IExternalForm インターフェース

IDocumentRequest インターフェース

Overview

Description

Example

See also
IClient インターフェース
INotification インターフェース

INotificationHandler インターフェース

Overview
INotificationHandler インターフェースは、Altium Designer システム内でブロードキャストされる通知を処理します。通知には、ドキュメントの読み込み通知、ワークスペースの読み込み、オブジェクトへのナビゲーション、サーバーモジュールの読み込みなどがあります。
イベントメッセージとしての通知は Client システムによってブロードキャストでき、開いている任意のサーバードキュメントがそれを受信して、適切に処理できます。Broadcast Notification はシステム全体の通知であり、Dispatch Notification はサーバー固有の通知です。
サーバープロジェクト内で Notification handler を登録するには（サーバーモジュールオブジェクト、パネルビューオブジェクト、またはドキュメントビューオブジェクトのいずれかで）
1. オブジェクトが作成されると、Client.RegisterNotificationHandler が呼び出されます。
2. オブジェクトが破棄されると、Client.UnregisterNotificationHandler が呼び出されます。
3. カスタム通知を処理するために、オブジェクトには HandlerNotification メソッドがあり、カスタム通知コードがインターセプトされたIProcessLauncherInfo インターフェース

Overview

IProcessLauncherInfo インターフェース階層は次のとおりです;

IProcessLauncherInfo Methods and Properties Table

See also

IProcessLauncherInfo のメソッド

GetCaption メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetCaption : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetDescription メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetDescription : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetImageFile メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetImageFile : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetKey メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetKey : Integer;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetKey2 メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetKey2 : Integer;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetParameters メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetParameters : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetServerCommand メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetServerCommand : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetShift メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetShift : TShiftState;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetShift2 メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetShift2 : TShiftState;
Description

Example

See also
IProcessLauncherInfo インターフェース

GetShortcutText メソッド

(IProcessLauncherInfo インターフェース)
Syntax
Function GetShortcutText : Widestring;
Description

Example

See also
IProcessLauncherInfo インターフェース

IProcessLauncherInfo のプロパティ

Caption プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Caption : Widestring Read GetCaption ;
Description

Example

See also
IProcessLauncherInfo インターフェース

Description プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Description : Widestring Read GetDescription ;
Description

Example

See also
IProcessLauncherInfo インターフェース

ImageFile プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property ImageFile : Widestring Read GetImageFile ;
Description

Example

See also
IProcessLauncherInfo インターフェース

Key プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Key : Integer Read GetKey ;
Description

Example

See also
IProcessLauncherInfo インターフェース

Key2 プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Key2 : Integer Read GetKey2 ;
Description

Example

See also
IProcessLauncherInfo インターフェース

Parameters プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Parameters : Widestring Read GetParameters ;
Description

Example

See also
IProcessLauncherInfo インターフェース

ServerCommand プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property ServerCommand : Widestring Read GetServerCommand;
Description

Example

See also
IProcessLauncherInfo インターフェース

Shift プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Shift : TShiftState Read GetShift ;
Description

Example

See also
IProcessLauncherInfo インターフェース

Shift2 プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property Shift2 : TShiftState Read GetShift2 ;
Description

Example

See also
IProcessLauncherInfo インターフェース

ShortcutText プロパティ

(IProcessLauncherInfo インターフェース)
Syntax
Property ShortcutText : Widestring Read GetShortcutText ;
Description

Example

See also
IProcessLauncherInfo インターフェース

IProcessControl インターフェース

Overview
IProcessControl インターフェースは、Altium Designer における各設計ドキュメントのプロセス深度を制御します。ドキュメント上でプロセスが起動されるたびに、プロセス深度は 1 ずつ増加し、その同じプロセスの実行が完了すると 1 ずつ減少します。プロセス深度が 0 の場合、現在の設計ドキュメント上では何も実行されていないことを示します。これは、特に Undo システムを含め、環境の同期を保つために必要です。

回路図および PCB ドキュメントのプロセス深度

Schematic API または PCB API を使用して、それぞれ回路図または PCB ドキュメント上のオブジェクトを変更または操作する場合、回路図または PCB ドキュメント上でオブジェクトを追加、削除、変更するときに環境が正しく更新されるよう、PreProcess メソッドと PostProcess メソッドを設定する必要があります。

See also
PostProcess メソッドおよび PreProcess メソッド用の IPCB_ServerInterface
PostProcess メソッドおよび PreProcess メソッド用の ISch_ServerInterface

IProcessControl のメソッド

PostProcess メソッド

(IProcessControl インターフェース)
Syntax
Procedure PostProcess (Const AContext : IInterface; AParameters : PChar);
Description
このプロシージャはメインサーバー内で後処理を実行します。これには、Undo システムなどのサーバー環境の状態を最終確定する処理が含まれる場合があります。AContext パラメータは通常、Altium Designer でフォーカスされているドキュメントであり、たとえば ISch_Document や IPCB_Board インターフェースです。
Example

//  Initialize  the  robots  in  Schematic  editor.
SchServer.ProcessControl.PreProcess(Doc,  '');

//  Create  a  new  port  and  place  on  current  Schematic  document.
SchPort  :=  SchServer.SchObjectFactory(ePort,eCreate_GlobalCopy);
If  SchPort  =  Nil  Then  Exit;
SchPort.Location  :=  Point(100,100);
SchPort.Style  :=  ePortRight;
SchPort.IOType  :=  ePortBidirectional;
SchPort.Alignment  :=  eHorizontalCentreAlign;
SchPort.Width  :=  100;
SchPort.AreaColor  :=  0;
SchPort.TextColor  :=  $FFFF00;
SchPort.Name  :=  'New  Port  1';

//  Add  a  new  port  object  in  the  existing  Schematic  document.
Doc.RegisterSchObjectInContainer(SchPort);
SchServer.RobotManager.SendMessage(Doc.I_ObjectAddress,c_BroadCast,
SCHM_PrimitiveRegistration,SchPort.I_ObjectAddress);

//  Clean  up  the  robots  in  Schematic  editor
SchServer.ProcessControl.PostProcess(Doc,  '');

See also
PreProcess メソッド

PreProcess メソッド

(IProcessControl インターフェース)
Syntax
Procedure PreProcess (Const AContext : IInterface; AParameters : PChar);
Description
メインサーバー内で前処理を実行します。これには、サーバー環境のリセットが含まれる場合があります。AContext パラメータは通常、Altium Designer でフォーカスされているドキュメントであり、たとえば ISch_Document や IPCB_Board インターフェースです
Example

//  Initialize  the  robots  in  Schematic  editor.
SchServer.ProcessControl.PreProcess(Doc,  '');

//  Create  a  new  port  and  place  on  current  Schematic  document.
SchPort  :=  SchServer.SchObjectFactory(ePort,eCreate_GlobalCopy);
If  SchPort  =  Nil  Then  Exit;
SchPort.Location  :=  Point(100,100);
SchPort.Style  :=  ePortRight;
SchPort.IOType  :=  ePortBidirectional;
SchPort.Alignment  :=  eHorizontalCentreAlign;
SchPort.Width  :=  100;
SchPort.AreaColor  :=  0;
SchPort.TextColor  :=  $FFFF00;
SchPort.Name  :=  'New  Port  1';

//  Add  a  new  port  object  in  the  existing  Schematic  document.
Doc.RegisterSchObjectInContainer(SchPort);
SchServer.RobotManager.SendMessage(Doc.I_ObjectAddress,c_BroadCast,
SCHM_PrimitiveRegistration,SchPort.I_ObjectAddress);

//  Clean  up  the  robots  in  Schematic  editor
SchServer.ProcessControl.PostProcess(Doc,  '');

See also
PostProcess メソッド

IProcessControl のプロパティ

ProcessDepth プロパティ

(IProcessControl インターフェース)
Syntax
Property ProcessDepth : Integer;
Description
プロセス深度を設定または取得します。深度値は整数値です。0 = 非アクティブ、1 以上は積み重なったプロセス数を示します。
ProcessDepth Example
ShowMessage('Current process depth ',IntToStr(Client.ProcessControl.ProcessDepth));

ILicenseManager インターフェース

Overview

ILicenseManager インターフェース階層は次のとおりです;

See also

ILicenseManager のメソッド

UseLicense メソッド

(ILicenseManager インターフェース)
Syntax
Procedure UseLicense (Const LicenseFileName : Widestring);
Description

Example

See also
ILicenseManager インターフェース

ReleaseLicense メソッド

(ILicenseManager インターフェース)
Syntax
Procedure ReleaseLicense (Const LicenseFileName : Widestring);
Description

Example

See also
ILicenseManager インターフェース

GetLicenses メソッド

(ILicenseManager インターフェース)
Syntax
Procedure GetLicenses (Licenses : TList);
Description

Example

See also
ILicenseManager インターフェース

ChangeToStandalone メソッド

(ILicenseManager インターフェース)
Syntax
Procedure ChangeToStandalone;
Description
このプロシージャは、コンピューター上で実行中の Altium Designer のライセンスを、ネットワークライセンスからスタンドアロンライセンスへ変更します。スタンドアロン コンピューターとは、インターネットに接続されていないコンピューターのことです。
Example

See also
ILicenseManager インターフェース

ChangeToNetwork メソッド

(ILicenseManager インターフェース)
Syntax
Procedure ChangeToNetwork (Const ServerName : Widestring);
Description
このプロシージャは、コンピューター上で実行中の Altium Designer のライセンスを、スタンドアロンライセンスからネットワークライセンスへ変更します。サーバー名は文字列として指定する必要があります。
スタンドアロン コンピューターとは、インターネットに接続されていないコンピューターのことです。
Example

See also
ILicenseManager インターフェース

UseLicenseByName メソッド

(ILicenseManager インターフェース)
Syntax
Procedure UseLicenseByName (Const LicenseName : Widestring);
Description

Example

See also
ILicenseManager インターフェース

IOptionsManager インターフェース

Overview
IOptionsManager インターフェースは、システム全体の Preferences ダイアログ、またはプロジェクト中心の Project Options ダイアログのオプションを扱います。
Notes
サーバーは、Altium Designer の Client モジュール内に独自のオプションページを登録する必要があります。Altium Designer RTL 内の RT_ServerImplementation ユニットにある TServerModule クラスには、オーバーライド可能な RegisterOptionsPageClass プロシージャがあります。ここには、オプションページの名前と、TOptionsForm 型の Options Form を渡す必要があります。通常、このフォームは、その上にコントロールが配置されたサーバーパネルフォームと同じものです。

Example
Procedure TGraphicPreferences.Save;
Var
Writer : IOptionsWriter;
Begin
Writer := Client.OptionsManager.GetOptionsWriter(CGraphicViewer);
If Writer = Nil Then Exit;
Writer.WriteBoolean(cGraphicPreferences, 'ScaleImage' , FScaleImage );
Writer.WriteBoolean(cGraphicPreferences, 'KeepAspectRatio', FKeepAspectRatio);
End;
See also
IOptionsReader インターフェース
IOptionsWriter インターフェース
IOptionsPage インターフェース
\Developer Kit\Examples\Dxp\GraphicViewer フォルダー内の GraphicViewer サーバープロジェクト

IOptionsManager のメソッド

OptionsExist メソッド

(IOptionsManager インターフェース)
Syntax
Function OptionsExist (Const ServerName, OldSettingsPath : WideString) : LongBool;
Description
この関数は、指定されたサーバーのオプションがシステム全体の Preference ダイアログ内に存在するかどうかを確認します。
Example

See also
IOptionsManager インターフェース

GetOptionsWriter メソッド

(IOptionsManager インターフェース)
Syntax
Function GetOptionsWriter (Const ServerName : WideString) : IOptionsWriter;
Description
この関数は IOptionsWriter メソッドを取得します。これにより、指定されたサーバーの Options に対して設定値を書き込めます。
Example

Var
  Writer  :  IOptionsWriter;
Begin
  Writer  :=  Client.OptionsManager.GetOptionsWriter(CGraphicViewer);
  If  Writer  =  Nil  Then  Exit;

  Writer.WriteBoolean(PreferencesName,  OptionName  ,  OptionValue);
End;

See also
IOptionsManager インターフェース
IOptionsWriter インターフェース
IOptionsReader インターフェース

GetOptionsReader メソッド

(IOptionsManager インターフェース)
Syntax
Function GetOptionsReader (Const ServerName, OldSettingsPath : WideString) : IOptionsReader;
Description
この関数は IOptionsReader メソッドを取得します。これにより、指定されたサーバーの Options に対する設定値を読み取れます。
Example

Var
  Reader  :  IOptionsReader;
Begin
  Reader  :=  Client.OptionsManager.GetOptionsReader(NameOfServer,'');
  If  Reader  =  Nil  Then  Exit;

  OptionValue  :=  Reader.ReadBoolean(ServerPreferencesName,OptionName,DefaultValue);
End;

See also
IOptionsManager インターフェース
IOptionsWriter インターフェース
IOptionsReader インターフェース

IOptionsReader インターフェース

Overview
IOptionsReader インターフェースは、システム全体の Preferences ダイアログまたは Project Options ダイアログのページ上のオプション値を、レジストリ ストレージから読み取ります。

Example

Var
  Reader  :  IOptionsReader;
Begin
  Reader  :=  Client.OptionsManager.GetOptionsReader(NameOfServer,'');
  If  Reader  =  Nil  Then  Exit;

  AValue  :=  Reader.ReadBoolean(NameOfServerPreferences,SettingName,DefaultValue);
End;

See also
IClient インターフェース
IOptionsManager インターフェース

IOptionsReader のメソッド

ValueExists メソッド

(IOptionsReader インターフェース)
Syntax
Function ValueExists (Const SectionName, ValueName : WideString) : LongBool;
Description
この関数は、このセクション名に対して値名が存在するかどうかを判定します。値をこの場所に書き込む前に、レジストリ ストレージ内にその値名が存在するかどうかを確認する必要がある場合に便利です。(IOptionsReader インターフェース)
Syntax
Function ReadString (Const SectionName, ValueName, DefaultValue : WideString) : WideString;
Description
ReadString 関数は、システム全体の Preferences ダイアログで表される、指定されたサーバーおよび設定名の文字列値を取得します。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsReader インターフェース

ReadSection メソッド

(IOptionsReader インターフェース)
Syntax
Function ReadSection (Const SectionName : WideString) : WideString;
Description
この関数は、システム全体の Preferences ダイアログ内の対象ページであるセクションのデータを取得します。
セクション名は、システム全体の Preferences ダイアログ内の対象ページであることに注意してください。
Example

See also
IOptionsReader インターフェース

ReadInteger メソッド

(IOptionsReader インターフェース)
Syntax
Function ReadInteger (Const SectionName, ValueName : WideString; DefaultValue : Integer) : Integer;
Description
ReadInteger 関数は、システム全体の Preferences ダイアログで表される、指定されたサーバーおよび設定名の整数値を取得します。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsReader インターフェース

ReadDouble メソッド

(IOptionsReader インターフェース)
Syntax
Function ReadDouble (Const SectionName, ValueName : WideString; DefaultValue : Double) : Double;
Description
ReadDouble 関数は、システム全体の Preferences ダイアログで表される、指定されたサーバーおよび設定名の double 値を取得します。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsReader インターフェース

ReadBoolean メソッド

(IOptionsReader インターフェース)
Syntax
Function ReadBoolean (Const SectionName, ValueName : WideString; DefaultValue : LongBool) : LongBool;
Description
ReadBoolean 関数は、システム全体の Preferences ダイアログで表される、指定されたサーバーおよび設定名のブール値を取得します。
ReadBoolean メソッドの DefaultValue パラメーターは、Preferences ダイアログ上の特定のコントロールが有効なブール値を返さない場合に、既定のブール値を返します。
セクション名は、システム全体の Preferences ダイアログ内の対象サーバーのページを表します。
Example

Var
  Reader  :  IOptionsReader;
Begin
  Reader  :=  Client.OptionsManager.GetOptionsReader(NameOfServer,'');
  If  Reader  =  Nil  Then  Exit;

  AValue  :=  Reader.ReadBoolean(NameOfServerPreferences,SettingName,DefaultValue);
End;

See also
IOptionsReader インターフェース

IOptionsWriter インターフェース

Overview
IOptionsWriter インターフェースは、システム全体の Preferences または Project options ダイアログ内のページ上のオプション値をレジストリ ストレージに書き込みます。

Example

Var
  Writer  :  IOptionsWriter;
Begin
  Writer  :=  Client.OptionsManager.GetOptionsWriter(CGraphicViewer);
  If  Writer  =  Nil  Then  Exit;
  Writer.WriteBoolean(cGraphicPreferences,  'ScaleImage'  ,  FScaleImage  );
  Writer.WriteBoolean(cGraphicPreferences,  'KeepAspectRatio',  FKeepAspectRatio);
End;

See also
IClient インターフェース
IOptionsManager インターフェース

IOptionsWriter メソッド

EraseSection メソッド

(IOptionsWriter インターフェース)
Syntax
Procedure EraseSection(Const SectionName : WideString);
Description
このプロシージャは、そのセクション（システム全体の Preferences ダイアログ内の対象ページ）のすべてのオプション値を削除します。
Example

See also
IOptionsWriter インターフェース

WriteInteger メソッド

(IOptionsWriter インターフェース)
Syntax
Procedure WriteInteger(Const SectionName, ValueName : WideString; Value : Integer);
Description
WriteInteger プロシージャは、システム全体の Preferences ダイアログで表される指定サーバー（SectionName）が使用するオプション名に対して、整数値を書き込みます。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsWriter インターフェース

WriteDouble メソッド

(IOptionsWriter インターフェース)
Syntax
Procedure WriteDouble (Const SectionName, ValueName : WideString; Value : Double);
Description
WriteDouble プロシージャは、システム全体の Preferences ダイアログで表される指定サーバー（SectionName）が使用するオプション名に対して、double 値を書き込みます。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsWriter インターフェース

WriteBoolean メソッド

(IOptionsWriter インターフェース)
Syntax
Procedure WriteBoolean(Const SectionName, ValueName : WideString; Value : LongBool);
Description
WriteBoolean プロシージャは、システム全体の Preferences ダイアログで表される指定サーバー（SectionName）が使用するオプション名に対して、ブール型のオプション値を書き込みます。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

Var
  Writer  :  IOptionsWriter;
Begin
  Writer  :=  Client.OptionsManager.GetOptionsWriter(CGraphicViewer);
  If  Writer  =  Nil  Then  Exit;

  Writer.WriteBoolean(cGraphicPreferences,  'ScaleImage'  ,  FScaleImage  );
  Writer.WriteBoolean(cGraphicPreferences,  'KeepAspectRatio',  FKeepAspectRatio);
End;

See also
IOptionsWriter インターフェース

WriteString メソッド

(IOptionsWriter インターフェース)
Syntax
Procedure WriteString (Const SectionName, ValueName, Value : WideString);
Description
WriteString プロシージャは、システム全体の Preferences ダイアログで表される指定サーバー（SectionName）が使用するオプション名に対して、文字列のオプション値を書き込みます。
セクション名は、システム全体の Preferences ダイアログ内の対象ページです。
Example

See also
IOptionsWriter インターフェース

IOptionsPage インターフェース

Overview
IOptionsPage インターフェースは、システム全体の Preferences ダイアログ内のコントロール ページを表します。たとえば Altium Designer では、この Preferences ダイアログ内のページ上のコントロールは、このサーバーのサーバー パネル上のコントロールからマップされます。ページ上のコントロールは、TOptionsForm オブジェクトとその IOptionsPage インターフェースによって表されます。
Note
サーバー モジュール（TServerModule クラス）には RegisterOptionsPageClass メソッドがあり、これが TOptionsForm オブジェクトを受け取ります。IOptionsPage インターフェースは、この TOptionsForm オブジェクトを表します。
TOptionsForm クラスには、OptionsPage、OptionsManager、OptionsReader、および OptionsWriter インターフェースを実装するためにオーバーライドする必要のあるメソッドがあります。
ClearModified
GetModified
GetStateControls
GetNotificationCode
DoSetStateControls
SetDefaultState

IOptionsPage Methods and Properties table

Example

  TGraphicPrefsForm_General  =  Class(TOptionsForm)
  chxScale  :  TCheckBox;
  chxProportional  :  TCheckBox;
  Private
  FScaleStored  :  Boolean;
  FProportionalStored  :  Boolean;
  Protected
  Procedure  ClearModified;  Override;
  Function  GetModified  :  Boolean;  Override;
  Procedure  GetStateControls;  Override;
  Function  GetNotificationCode  :  Integer;  Override;
  Procedure  DoSetStateControls;  Override;
  Procedure  SetDefaultState;  Override;
  End;
\{..........................................................................\}
Function  TGraphicPrefsForm_General.GetNotificationCode:  Integer;
Begin
  Result  :=  cGraphicPreferencesChanged;
End;
Procedure  TGraphicPrefsForm_General.GetStateControls;
Begin
  gv_GraphicPreferences.ScaleImage  :=  chxScale  .Checked;
  gv_GraphicPreferences.KeepAspectRatio  :=  chxProportional.Checked;
End;
Procedure  TGraphicPrefsForm_General.DoSetStateControls;
Begin
  chxScale  .Checked  :=  gv_GraphicPreferences.ScaleImage;
  chxProportional.Checked  :=  gv_GraphicPreferences.KeepAspectRatio;
End;
Procedure  TGraphicPrefsForm_General.SetDefaultState;
Begin
  chxScale  .Checked  :=  False;
  chxProportional.Checked  :=  False;
  Inherited;
End;
Procedure  TGraphicPrefsForm_General.ClearModified;
Begin
  FScaleStored  :=  chxScale.Checked;
  FProportionalStored  :=  chxProportional.Checked;
End;
Function  TGraphicPrefsForm_General.GetModified  :  Boolean;
Begin
  Result  :=  (FScaleStored  <>  chxScale.Checked)  Or
  (FProportionalStored  <>  chxProportional.Checked);
End;

See also
IOptionsManager インターフェース
IOptionsReader インターフェース
IOptionsWriter インターフェース

IOptionsPage の GetState および SetState メソッド

GetModified メソッド

(IOptionsPage インターフェース)
Syntax
Function GetModified : Boolean;
Description

Example

See also
IOptionsPage インターフェース

SetModified メソッド

(IOptionsPage インターフェース)
Syntax
Procedure SetModified(Value : Boolean);
Description

Example

See also
IOptionsPage インターフェース

IOptionsPage メソッド

SetStateControls メソッド

(IOptionsPage インターフェース)
Syntax
Procedure SetStateControls;
Description
このプロシージャは、サーバー モジュール内のデータ構造からフォーム上のコントロールを更新します。
Example

See also
IOptionsPage インターフェース

SetDefaultState メソッド

(IOptionsPage インターフェース)
Syntax
Procedure SetDefaultState;
Description
このプロシージャは、システム全体の Preferences ダイアログ内のページ上のコントロールを既定値に設定します。
Note
SetDefaultState プロシージャは、サーバーの TOptionsForm オブジェクト内でオーバーライドされます。
Example

See also

IOptionsPage インターフェース

PostEditControls メソッド

(IOptionsPage インターフェース)
Syntax
Procedure PostEditControls;
Description

Example

See also
IOptionsPage インターフェース

GetStateControls メソッド

(IOptionsPage インターフェース)
Syntax
Procedure GetStateControls;
Description
このプロシージャ
Note

Example

See also
IOptionsPage インターフェース

GetNotificationCode メソッド

(IOptionsPage インターフェース)
Syntax
Function GetNotificationCode : Integer;
Description
Altium Designer でサーバー パネルおよびシステム全体の Preferences ダイアログへの Option 通知を処理する各サーバーは、100 以上の値を取り得る独自の Notification code を持ちます。
Note
サーバー モジュールには TOptionsForm オブジェクトが登録されており、このオブジェクトでは GetNotificationCode 関数がオーバーライドされます。このサーバー モジュールは独自の通知コード値を持ちます。これらの通知コードが一意であることを確認してください。
Example

See also
IOptionsPage インターフェース

IOptionsPage のプロパティ

Modified プロパティ

(IOptionsPage インターフェース)
Syntax
Property Modified : Boolean Read GetModified Write SetModified;
Description

Example

See also
IOptionsPage インターフェース

IServerProcess インターフェース

Overview
IServerProcess インターフェースは、サーバーのインストール ファイル内のコマンド（サーバー プロセス）に関する情報を返します。

• コマンド名（GetOriginalID メソッド）
• 詳細サマリー
• パラメーター数（存在する場合）
• パラメーター名（存在する場合）

IServerProcess インターフェースは、IServerRecord インターフェース内で使用される集約インターフェースです。
Notes
一般的なインストール ファイル構造は以下のとおりです
ClientInsFile 1.0
Server
EditorName = 'AddOn'
EditorExePath = 'AddOn.DLL'
EditorDescription = 'A demonstratory AddOn module'
Version = 'Version 8.1.4.2763'
Date = '24-Dec-2004'
HelpAboutInfo = 'This software is protected by copyright law and international treaties.'
Copyright = 'Copyright © Altium Limited 2004'
Updates = 'ADVPCB'
End
Command Name = 'CountPads' LongSummary = 'Find how many pads on a PCB document' End
Command Name = 'RunAPCBProcess' LongSummary = 'Invoke a PCB process' End

Example

//ServerRecord  is  a  IServerRecord  interface
CommandCount  :=  ServerRecord.GetCommandCount;
For  J  :=  0  To  CommandCount  -  1  Do
Begin
  //ServerProcess  is  a  IServerProcess  interface
  ServerProcess  :=  ServerRecord.GetCommand(J);
  ReportFile.Add('  Process  #'  +  IntToStr(J  +  1)  +  '  Name  =  '  +
  ServerProcess.GetOriginalId  +  '  LongSummary  =  '  +  ServerProcess.GetLongSummary);

  ParameterCount  :=  ServerProcess.GetParameterCount;
  For  K  :=  0  To  ParameterCount  -  1  Do
  S  :=  S  +  ServerProcess.GetParameter(K)  +  ',  ';

  ReportFile.Add('  Parameters  =  '  +  S);
End;

Notes
プリミティブの配置、ズーム レベルの変更など、ユーザーが利用できるサーバー内のすべての機能は、あらかじめパッケージ化されたプロセス ランチャーであるコマンドによって実行されます。これらの事前パッケージ化されたプロセス ランチャーには、コマンド選択時に実行されるプロセスに加え、必要に応じてパラメーター、ビットマップ（アイコン）、キャプション（リソース上に表示される項目名）、説明、および関連するショートカット キーがまとめられています。
メニュー項目を選択したりツールバー ボタンをクリックしたりすると、プロセスが起動されます。プロセスは、プロセス識別子を適切なサーバーに渡すことで起動され、サーバーがその後プロセスを実行します。プロセスは、サーバー ソース コード プロジェクトの Commands ユニットで定義および実装されます。これらのプロセスは、インストール ファイル（INS 拡張子）で宣言されます。
各プロセスにはプロセス識別子があります。プロセス識別子は、コロンで区切られた 2 つの部分から構成されます。最初の部分はそのプロセスを定義するサーバーを示し、2 番目の部分はプロセス名です。
たとえば、プロセス Sch:ZoomIn は Schematic サーバーによって提供されます。このプロセスが起動されると、メニュー項目の選択、ホットキーの押下、またはツールバー ボタンのアクティブ化（これらはいずれもプロセス ランチャーとして定義されています）によって、現在アクティブな回路図シートをズームインする処理が実行されます。
サーバーが初めて起動されると、サーバー モジュール内の CommandLauncher オブジェクトにプロセス プロシージャまたはコマンドが登録されます。

See also
IServerRecord インターフェース
\Examples\Scripts\DXP\ フォルダー内の ServerProcessReport スクリプト

IServerProcess メソッド

GetLongSummary メソッド

(IServerProcess インターフェース)
Syntax
Function GetLongSummary : WideString;
Description
GetLongSummary 関数は、Long Summary 識別子文字列を返します。
Example

See also
IServerProcess インターフェース
IServerRecord インターフェース

GetOriginalId メソッド

(IServerProcess インターフェース)
Syntax
Function GetOriginalId : WideString;
Description
GetOriginalID メソッドは、指定されたサーバー プロセスの Process Identifier 文字列を返します。
Example

See also
IClient インターフェース
IServerProcess インターフェース

GetParameter メソッド

(IServerProcess インターフェース)
Syntax
Function GetParameter(Index : Integer) : WideString;
Description
GetParameter 関数は、index パラメータに応じて指定されたインデックスのパラメータ文字列を返します。これは GetParameterCount メソッドと組み合わせて使用します。サーバープロセスはパラメトリックにすることができ、そのため複数のパラメータを持つ場合があります。
Example
See also
IClient インターフェース
IServerProcess インターフェース
GetParameterCount メソッド

GetParameterCount メソッド

(IServerProcess インターフェース)
Syntax
Function GetParameterCount : Integer;
Description
GetParameterCount 関数は、現在の Process Identifier (GetOriginalID) に対するパラメータ数を返します。
これは GetParameter メソッドと組み合わせて使用します。
Example

See also
IClient インターフェース
IServerProcess インターフェース
GetParameter メソッド

IServerRecord インターフェース

Overview
このインターフェースは、サーバーのインストールファイル一覧を持つ \System フォルダーから、サーバーのインストールファイル情報を取得します。つまり、各サーバーインストールファイル（INS 拡張子を持つ）は、それぞれ 1 つの IServerRecord インターフェースに対応します。
この IServerRecord インターフェースは Client オブジェクト内にあるため、Client.GetServerRecordCount を呼び出してサーバーインストールファイル数を取得し、その後 Client.GetServerRecord(RecordCount) を IServerRecord 変数に代入することで、インストールファイルに関連付けられたデータを取得できます。
Altium Designer にインストールされている各サーバーモジュールの詳細情報を確認するには、IClient.GetServerModule インターフェースを呼び出します。

Example
PCB_SR := Client.GetServerRecordByName('PCB');
See also
IClient インターフェース
IServerModule インターフェース
\Developer Kit\Examples\DXP\ClientServer Interfaces\ フォルダー内の CS サーバーの例。

IServerRecord のメソッド

GetCommand メソッド

(IServerRecord インターフェース)
Syntax
Function GetCommand(Index : Integer) : IServerProcess;
Description
このメソッドは IServerProcess インターフェースを返します。GetCommandCount 関数と組み合わせて使用します。
Example

See also
IServerRecord インターフェース

GetCommandCount メソッド

(IServerRecord インターフェース)
Syntax
Function GetCommandCount : Integer;
Description
このメソッドは、このサーバーがサポートするコマンド（Process launcher）の数を返します。
GetCommand 関数と組み合わせて使用します
Example

See also
IServerRecord インターフェース

GetCopyRight メソッド

(IServerRecord インターフェース)
Syntax
Function GetCopyRight : PChar;
Description
このメソッドは著作権文字列を返します。
Example

See also
IServerRecord インターフェース

GetDescription メソッド

(IServerRecord インターフェース)
Syntax
Function GetDescription : PChar;
Description
このメソッドは説明文字列を返します。
Example

See also
IServerRecord インターフェース

GetExePath メソッド

(IServerRecord インターフェース)
Syntax
Function GetExePath : PChar;
Description
このメソッドはサーバーファイルへのパスを返します。
Example

See also
IServerRecord インターフェース

GetDate メソッド

(IServerRecord インターフェース)
Syntax
Function GetDate : PChar;
Description
このメソッドは、サーバーインストールファイルに関連付けられた日付文字列を返します。
Example

See also
IServerRecord インターフェース

GetGeneralInfo メソッド

(IServerRecord インターフェース)
Syntax
Function GetGeneralInfo : PChar;
Description
このメソッドは、サーバーに関連付けられたサーバーレコードの一般情報文字列を返します。
Example

See also
IServerRecord インターフェース

GetInsPath メソッド

(IServerRecord インターフェース)
Syntax
Function GetInsPath : PChar;
Description
このメソッドはインストールファイルへのパスを返します。
Example

See also
IServerRecord インターフェース

GetName メソッド

(IServerRecord インターフェース)
Syntax
Function GetName : PChar;
Description
このメソッドはサーバー名を返します。
Example

See also
IServerRecord インターフェース

GetPanelInfo メソッド

(IServerRecord インターフェース)
Syntax
Function GetPanelInfo (Index : Integer) : IServerPanelInfo;
Description
このメソッドは、指定されたインデックスのパネル情報を返します。これは GetPanelInfoCount メソッドと組み合わせて使用します。
Example

See also
IServerRecord インターフェース

GetPanelInfoByName メソッド

(IServerRecord インターフェース)
Syntax
Function GetPanelInfoByName (Const Name : Widestring) : IServerPanelInfo;
Description
このメソッドは、パネル名によってパネル情報インターフェースを返します。
Example

See also
IServerRecord インターフェース

GetPanelInfoCount メソッド

(IServerRecord インターフェース)
Syntax
Function GetPanelInfoCount : Integer;
Description
このメソッドは、サーバーモジュールで使用されるパネルの数を返します。これは GetPanelInfo メソッドと組み合わせて使用します。
Example

See also
IServerRecord インターフェース

GetRCSFilePath メソッド

(IServerRecord インターフェース)
Syntax
Function GetRCSFilePath : PChar;
Description
このメソッドはリソースファイルへのパスを返します。
Example

See also
IServerRecord インターフェース

GetSystemExtension メソッド

(IServerRecord インターフェース)
Syntax
Function GetSystemExtension : LongBool;
Description
このメソッドはファイルシステム拡張子文字列を返します。
Example

See also
IServerRecord インターフェース

GetVersion メソッド

(IServerRecord インターフェース)
Syntax
Function GetVersion : PChar;
Description
このメソッドは、サーバーインストールファイルに関連付けられたバージョン文字列を返します。
Example

RecordCount  :=  Client.GetServerRecordCount;
For  I  :=  0  to  RecordCount  -  1  Do
Begin
  //  obtain  details  of  the  DXP.INS  file
  ServerRecord  :=  Client.GetServerRecord(I);
  If  ServerRecord.GetName  =  'Client'  Then
  Begin
  Version  :=  ServerRecord.GetVersion;
  Break;
  End;
End;

See also
IServerRecord インターフェース

GetServerFileExist メソッド

(IServerRecord インターフェース)
Syntax
Function GetServerFileExist : LongBool;
Description
このメソッドは、サーバーファイル（DLL を持つ）が存在するかどうかの Boolean 値を返します。
Example

See also
IServerRecord インターフェース

GetWindowKind メソッド

(IServerRecord インターフェース)
Syntax
Function GetWindowKind (Index : Integer) : IServerWindowKind;
Description
このメソッドは IServerWindowKind インターフェースを返します。GetWindowKindCount 関数と組み合わせて使用します。
Example

See also
IServerRecord インターフェース

GetWindowKindCount メソッド

(IServerRecord インターフェース)
Syntax
Function GetWindowKindCount : Integer;
Description
このメソッドは、このサーバーがサポートするドキュメント種別の数を返します。
Example

See also
IServerRecord インターフェース

GetWindowKindByName メソッド

(IServerRecord インターフェース)
Syntax
Function GetWindowKindByName(Name : PChar ) : IServerWindowKind
Description
このメソッドは、DocumentKind Name パラメータに応じて IServerWindowKind インターフェースを返します。
Example

See also
IServerRecord インターフェース
IServerWindowKind インターフェース

IServerWindowKind インターフェース

Overview
この IServerWindowKind インターフェースは、Altium Designer における設計ドキュメントのタイプを通知するもので、IServerRecord および IClient インターフェースオブジェクトで使用される複合オブジェクトです

See also
IClient インターフェース
IServerRecord インターフェース

IServerWindowKind のメソッド

FileLoadDescriptionCount メソッド

(IServerWindowKind インターフェース)
Syntax
Function FileLoadDescriptionCount : Integer;
Description
このメソッドは、サーバーのドキュメントエディタータイプに対する File Load Description の数を返します。ドキュメントエディターは複数のドキュメントタイプをサポートできるため、複数のロード機能を提供できます。
Example

See also
IClient インターフェース
IServerWindowKind インターフェース

FileSaveDescriptionCount メソッド

(IServerWindowKind インターフェース)
Syntax
Function FileSaveDescriptionCount : Integer;
Description
このメソッドは、ドキュメントエディターサーバーの File Save Description の数を返します。ドキュメントエディターは複数のドキュメントタイプを持つことができるため、それに対応する複数のファイル保存機能を持つことができます。
Example

See also
IClient インターフェース
IServerWindowKind インターフェース

GetFileLoadDescription メソッド

(IServerWindowKind インターフェース)
Syntax
Function GetFileLoadDescription(Index : Integer) : Widestring;
Description
このメソッドは、指定されたインデックスのファイルロード説明を返します。FileLoadDescriptionCount 関数と組み合わせて使用します。
Example

See also
IClient インターフェース
IServerWindowKind インターフェース

GetFileSaveDescription メソッド

(IServerWindowKind インターフェース)
Syntax
Function GetFileSaveDescription(Index : Integer) : Widestring;
Description
このメソッドは、指定されたインデックスのファイル保存説明を返します。FileSaveDescriptionCount 関数と組み合わせて使用します。
Example

See also
IClient インターフェース
IServerWindowKind インターフェース

GetIconName メソッド

(IServerWindowKind インターフェース)
Syntax
Function GetIconName : Widestring;
Description
このメソッドは、DXP 内のドキュメントのサーバーウィンドウに関連付けられたアイコン名を返します。
Example

See also
IClient インターフェース
IServerWindowKind インターフェース