DEVELOPMENT GUIDE / C#・VB.NET

Visual StudioからカスタマイズDLLを作る

Free版とカスタマイズの利用条件

Free版は配布時の「APIサンプル」10コマンドだけを利用できます。独自DLLと変更したサンプルの実行には、有効なSTDまたはProライセンスが必要です。Free版ではサンプルの名前・IDを使っても外部DLLのコードは実行せず、本体に同梱されたサンプルを実行します。変更が反映されない場合は[読込状況]とプランを確認してください。C#/VB.NETの実習サンプルを自作DLLとして読み込む場合もSTD/Proが必要です。

MCPはFree版でも使用できます。通常の作図・編集APIは利用でき、板金・解析のAPIはライセンス判定で拒否されます。独自DLLの読込み制限とMCP接続の可否は別です。

1. 開発環境

  1. Visual Studio 2022 17.8以降と.NET 8 SDKを用意します。Visual Studio Installerで[.NET デスクトップ開発]を選択します。
  2. 更新版JDesignCADを用意します。SDKは本体フォルダーのCustomization\SDKにあります。
  3. SDKフォルダー全体を開発フォルダーへコピーします。ApiとSamplesの相対位置を維持すると、同梱プロジェクトの参照がそのまま使えます。

Microsoft公式:Visual Studioでクラスライブラリを作る、.NETとVisual Studioの対応。

2. 同梱サンプルから開始する

Visual Studioの[プロジェクトまたはソリューションを開く]で、次のいずれかを開きます。

実用コマンド10例を改造する場合はAPIサンプルの説明をご覧ください。Windows Forms入力画面を使うためUseWindowsForms=trueが必要です。

言語ファイル内容
C#SDK\Samples\Customization.Sample\Customization.Sample.csprojAPIサンプル:文字連番・複写・整理・集計の10例。API 1.3以降。
C#SDK\Samples\Customization.Workshop\Customization.Workshop.csprojタブ、ボタン、線と円、箱、滑らかな角―角ロフト、選択情報、Undo
VB.NETSDK\Samples\Customization.WorkshopVB\Customization.WorkshopVB.vbprojタブ、ボタン、線分作成。Option Strict On。

構成はRelease、プラットフォームターゲットはx64です。[ビルド]→[ソリューションのビルド]を実行します。通常の出力先はbin\Release\net8.0-windowsです。クラスライブラリのため、DLLをF5で直接実行することはできません。

3. 新規プロジェクトから開始する場合

  1. [新しいプロジェクトの作成]→C#またはVisual Basicのクラスライブラリを選択します。.NET Framework版ではなく、.NET 8版を使用します。
  2. プロジェクトファイルを次のように設定します。HintPathは実際のSDKに合わせます。
  3. [依存関係]→[参照の追加]→[参照]でSDK\Api\JDesignCAD.Api.dllを指定します。参照の[ローカルにコピー]はFalseにします。
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0-windows</TargetFramework>
    <PlatformTarget>x64</PlatformTarget>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <EnableDynamicLoading>true</EnableDynamicLoading>
  </PropertyGroup>
  <ItemGroup>
    <Reference Include="JDesignCAD.Api">
      <HintPath>..\..\Api\JDesignCAD.Api.dll</HintPath>
      <Private>false</Private>
    </Reference>
    <None Update="addin.json" CopyToOutputDirectory="PreserveNewest" />
  </ItemGroup>
</Project>

WinFormsの入力画面を作る場合は<UseWindowsForms>true</UseWindowsForms>も追加します。VB.NETではRootNamespaceとOptionStrictを設定します。内部のJDesignCoreやKryptonの参照は、タブ・ボタン登録や共通APIの利用には不要です。

EnableDynamicLoadingと共有契約DLLについて:Microsoftのプラグイン対応アプリの説明。

4. 起動クラスとコマンドを書く

ICadAddin.OnStartupでタブを登録し、各ボタンにはIAddinCommandを実装したクラスを渡します。OnStartupは登録だけを行い、図面変更や長い処理はボタンから実行します。コードは同梱のWorkshopAddin.cs/WorkshopAddin.vbと実装例を参照してください。

非同期処理はawait/Awaitで呼び出します。UIスレッドで.Resultや.Wait()を使うと、UIへ戻る処理を待ち続ける可能性があります。重い3D計算はStartOperationAsyncを使用し、完了後にCommitJobAsyncを呼びます。

5. addin.jsonを作る

{
  "id": "MyCompany.MyTool",
  "name": "自社の加工支援",
  "apiVersion": 1,
  "assembly": "MyTool.dll",
  "entryType": "MyCompany.MyTool.MyAddin",
  "enabled": true
}
項目設定
idほかの拡張と重複しない識別子。同じ拡張の更新では維持。
apiVersion主バージョンの1。API 1.2・1.3でも1です。
assemblyビルドで生成されたDLL名。拡張フォルダー内の相対パス。
entryTypeICadAddinを実装したpublicクラスの完全名。引数なしで生成できること。
enabledfalseで読込みを無効化。

VB.NETの完全名は「プロジェクトのルート名前空間+クラス名」です。ソースにも同じNamespaceを書くと二重になるため、同梱VBサンプルではソース側のNamespaceを省いています。

6. 配置して起動

  1. 図面を保存してJDesignCADを終了します。
  2. %LOCALAPPDATA%\JDesignCAD\Addins\MyCompany.MyToolを作成します。
  3. 自分のDLL、addin.json、生成されたdeps.json、使用している依存DLL、必要ならpdb・アイコンをコピーします。JDesignCAD.Api.dllは本体側のものを共有します。
  4. JDesignCADを再起動し、[カスタマイズ]→[読込状況]を確認します。
  5. 図面を開いて追加タブのボタンを押します。

SmallIconPath/LargeIconPathは拡張フォルダーを基準としたパスです。未指定は画像なし。グループを折りたたんだときは、先頭ボタンのアイコンが使われます。DLL更新後は本体の再起動が必要です。

7. ブレークポイントで確認

  1. Debug構成でビルドし、DLLとpdbを拡張フォルダーへ配置してJDesignCADを起動します。
  2. Visual Studioの[デバッグ]→[プロセスにアタッチ]でJDesignCAD.exeを選び、マネージド(.NET Core/.NET 5以降)コードへ接続します。
  3. ExecuteAsyncの先頭へブレークポイントを置き、CADのボタンを押します。
  4. 停止しないときは[デバッグ]→[ウィンドウ]→[モジュール]で、読み込んだDLLの場所とシンボルを確認します。

OnStartupを追うときは、デバッグ設定で外部プログラムとしてJDesignCAD.exeを指定して起動するか、起動時ログを利用します。計算エンジンは別のAutomation.Workerプロセスです。追加DLL側ではジョブのstate・errorCode・messageを確認してください。Microsoft公式:実行中プロセスへのアタッチ。

8. 配布と互換性

拡張フォルダーをまとめて配布します。実習サンプルはAPI 1.2以降、板金・解析はSTD/Proが必要です。SDKの公開DLLとXMLを一緒に参照するとIntelliSenseに説明が出ます。内部のCAD型やJDC構造を直接書き換える実装は、共通APIの互換性保証に含まれません。