NextDesign.Interop 1.1.2.10908

1. 概要

• Next Design を外部アプリケーションから制御するための.NETライブラリです。
• 制御対象の Next Design には NDInterop エクステンションのインストールが必要です。

2. インストール方法

コマンドプロンプトより次のように実行してください。

> dotnet add package NextDesign.Interop

3. 利用方法

制御は Next Design のスクリプトを呼び出すことによって実現します。スクリプトでプロジェクトファイルを読み込んだり、保存したりエラーチェックをしたり、UI の状態を変更できます。また、UI の状態を戻り値で返すことで連続的な操作も可能です。

インストールしている Next Design を新規に起動する場合は NextDesignAppFactory.Start() を用います。Next Design のプロジェクトファイルが関連づいている Next Design のプログラムのパスを自動的に検索して起動します。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;

// インストールしている Next Design を起動します。
var ndApp = NextDesignAppFactory.Start();
var ret = ndApp.RunScript("return Version;");
Console.WriteLine(ret.ReturnValue);

Next Design のアプリケーションのパスを指定しての実行も可能です。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;

var ndApp = NextDesignAppFactory.Start(@"C:\Program Files\....\NextDesign.exe");
var ret = ndApp.RunScript("return Version;");
Console.WriteLine(ret.ReturnValue);

起動している Next Design にアタッチする場合は NextDesignAppFactory.Attach() メソッドを用います。NextDesignAppFactory.AttachOrStart() を用いれば、プロセスがあればアタッチしてなければ自動的に起動します。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;

// 複数起動している場合はプロセスIdが一番大きい（新しいプロセス）にアタッチします
var ndApp = NextDesignAppFactory.Attach();
var ret = ndApp.RunScript("return Version;");
Console.WriteLine(ret.ReturnValue);

特定のプロセスにアタッチする場合は Process や processId を渡します。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;
using System.Diagnostics;

var process = Process.Start(@"C:\Program Files\....\NextDesign.exe");
var ndApp = NextDesignAppFactory.Attach(process);
var ret = ndApp.RunScript("return Version;");

特定の Next Design のプロセスを探してアタッチする場合は次のようにします。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;

var projectFile = "...";
var processes = NextDesignAppFactory.GetNextDesignProcesses();
INextDesignApp app = null;

foreach (var process in processes)
{
    var ndApp = NextDesignAppFactory.Attach(process);
    if (ndApp.CurrentProjectFilePath == projectFile)
    {
        app = ndApp;
        break;
    }
}

var result = app.RunScript("...");

if (!result.IsSuccess)
{
    Console.WriteLine($"エラーが発生しました。{result.ErrorMessage}");
}
else
{
    // スクリプトに戻り値があれば `RunScriptResult.ReturnValue` プロパティで取得できます。
    Console.WriteLine($"[成功] {result.ReturnValue}");
}

実行中の Next Design の指定プロセスにアタッチするか、なければ起動する場合は次のようにします。

using NextDesign.Interop;
using NextDesign.Interop.Interfaces;

// 複数起動している場合はプロセスIdが一番大きい（新しいプロセス）にアタッチします
var ndApp = NextDesignAppFactory.AttachOrStart();
var ret = ndApp.RunScript("return Version;");
Console.WriteLine(ret.ReturnValue);

実行結果は RunScriptResult オブジェクトで取得できます。

using NextDesign.Interop.Interfaces;

var result = app.RunScript("...");

if (!result.IsSuccess)
{
    Console.WriteLine($"エラーが発生しました。{result.ErrorMessage}");
}
else
{
    // スクリプトに戻り値があれば `RunScriptResult.ReturnValue` プロパティで取得できます。
    Console.WriteLine($"[成功] {result.ReturnValue}");
}

必要に応じて、Start() で新規起動したり、Attach() で既存プロセスに接続したりできます。

4. パッケージのアンインストール方法

次のコマンドを実行してください。

> dotnet remove package NextDesign.Interop