NextDesign.Interop.Interfaces 1.1.1.10908

1. 概要

• Next Design と外部アプリケーション/拡張機能の間で共有するインターフェースと共通データ型を定義する.NETライブラリです。
• 実際の制御処理は含まず、NextDesign.Interop がこの契約を利用します。

2. インストール方法

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

> dotnet add package NextDesign.Interop.Interfaces

3. 利用方法

3.1. 参照する

NextDesign.Interop.Interfaces を参照し、インターフェース経由で Next Design の機能を利用する実装を記述します。

using NextDesign.Interop.Interfaces;

public class Sample
{
    private readonly INextDesignApp _app;

    public Sample(INextDesignApp app)
    {
        _app = app;
    }

    public void ShowInfo()
    {
        Console.WriteLine(_app.Version);
    }
}

3.2. スクリプトを実行する

RunScript() でプロジェクトを実行します。以下ではモデル数とリレーション数を出力ペインに表示する例です。

using System;
using NextDesign.Interop.Interfaces;

public class Sample
{
    private readonly INextDesignApp _app;

    public Sample(INextDesignApp app)
    {
        _app = app;
    }

    public void ShowSummary()
    {
        var script = @"
const string category = "モデル・関連数カウント";
var project = App.Workspace.OpenProject(""C:\Work\Sample.nproj"");
var models = project.GetAllChildren().ToList();
var relationshipCount = models
    .Prepend(project.DesignModel)
    .SelectMany(model => model.GetRelationsWhere(
        (relationship, field) => true))
    .Select(relationship => relationship.Id)
    .Distinct()
    .Count();

Output.Clear(category);
Output.WriteLine(category, $"プロジェクト名 : {project.Name}");
Output.WriteLine(category, $"モデル数       : {models.Count}");
Output.WriteLine(category, $"関連数         : {relationshipCount}");

Window.IsInformationPaneVisible = true;
Window.ActiveInfoWindow = "Output";
Window.CurrentOutputCategory = category;
";

        var result = _app.RunScript(script);

        if (!result.IsSuccess)
        {
            Console.WriteLine(result.ErrorMessage);
            return;
        }

        Console.WriteLine(result.ReturnValue);
    }
}

3.3. 結果を受け取る

RunScriptResult には IsSuccess、ErrorMessage、ReturnValue、Exception が入ります。失敗時は ErrorMessage に加えて Exception の詳細を確認できます。

using System;
using NextDesign.Interop.Interfaces;

var result = _app.RunScript("return Version;");

if (result.IsSuccess)
{
    Console.WriteLine($"[成功] {result.ReturnValue}");
}
else
{
    Console.WriteLine($"[失敗] {result.ErrorMessage}");
    if (result.Exception != null)
    {
        Console.WriteLine(result.Exception.GetDetailedMessage());
    }
}

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

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

> dotnet remove package NextDesign.Interop.Interfaces