◀ 4.

【Revit API】アドインの作成サンプル（外部ツール編）

▶

この記事の要点

  • Revit アドイン（外部ツール / IExternalCommand）の C# サンプル
  • 前提: Visual Studio + Revit インストール済み
  • 実装: IExternalCommand を実装し Execute() 内で TaskDialog.Show("Revit", "Hello World")
  • .addin マニフェストで Type="Command" として登録

 

1前提

Visual Studioをインストール済み

Revitをインストール済み (今回使用するバージョンは2021)

今回はC#を例に簡単なアドインを作成する（Hello Worldをダイアログで表示させるアドイン）

 

2プロジェクトの作成

Visual Studioでプロジェクトを新規作成する。

C#を使えるクラスライブラリを選択する。

プロジェクトの作成の図

プロジェクト名は「CsSampleProject」とする。

 

以下のファイルが自動で作成される。

Class1.cs
using System;

namespace CsSampleProject
{
    public class Class1
    {
    }
}
 

 

※Revit 2024 以前は「.NET Framework」（4.8）のクラスライブラリを使用すること（Revit 2025 以降は .NET 8）

その場合、そのままではビルドが成功しないので、「プロジェクトを右クリック」→「プロパティ」→「アプリケーション」タブ にある「出力の種類」を「クラス ライブラリ」に変更する。

プロジェクトの作成の図

 

3DLLの参照

作ったプロジェクトがRevit APIのDLLを参照するように設定する。

参照方法は以下の記事を参照。

https://jpn.itlibra.com/article?id=21487

 

4実装

最初に作られたクラスに以下の記述をする。

Class1.cs

using System;
using Autodesk.Revit.UI;
using Autodesk.Revit.DB;

namespace CsSampleProject
{
    [Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
    public class Class1: IExternalCommand
    {
        public Autodesk.Revit.UI.Result Execute(ExternalCommandData revit,
            ref string message, ElementSet elements)
        {
            TaskDialog.Show("Revit", "Hello World");
            return Autodesk.Revit.UI.Result.Succeeded;
        }
    }
}

 

5ビルド

「ビルド」→「ソリューションのビルド」を選択する。

ビルドの図

ビルドエラーが無いかコンソールで確認すること。

ビルドしたdllファイルの出力先はコンソール上に表示される。

dllは最終的には後述するマニフェストファイルと同じパスに保存することを推奨する。

 

6マニフェストファイルの作成

以下のようなマニフェストファイルを作成します。

CsSampleProject.addin

<RevitAddIns>

    <AddIn Type="Command">

        <Text>SampleAddin</Text>

        <Description>アドインの説明</Description>

　　  <Assembly>C:\ ... \CsSampleProject.dll</Assembly>

        <FullClassName>CsSampleProject.Class1</FullClassName>

        <ClientId>3B1635B8-FAE7-4E07-A2B3-6EC7B8AEF57E</ClientId>

        <VendorId>会社名</VendorId>

        <VendorDescription>会社説明</VendorDescription>

    </AddIn>

</RevitAddIns>

※Assemblyはdllの出力先を指定する。

マニフェストファイルの詳細な定義方法は以下の記事を参照。

https://jpn.itlibra.com/article?id=21489

 

7マニフェストファイルの設置

以下の記事を参照。

https://jpn.itlibra.com/article?id=21488

 

8外部ツールの実行

Revitを再起動する。

「アドイン」タブを押す。

「外部ツール」から追加した外部ツールを選択する。

Hello Worldのダイアログが表示されればOK。

外部ツールの実行の図

Post Share
子ページ

子ページはありません

同階層のページ
  1. RevitAPI.dll と RevitAPIUI.dll の参照
  2. マニフェストファイルの書き方
  3. アドインの追加/設置方法
  4. アドインの作成サンプル（外部ツール編）
  5. アドインの作成サンプル（外部アプリケーション編）
  6. 要素の取得と情報の表示
  7. 要素のカテゴリとマテリアルの取得と表示
  8. よく使うBuiltInCategoryの一覧
  9. 外部ツールでAutodesk.Revit.Documentを取得する方法
  10. エラーメッセージの設定方法
  11. 「はい」、「いいえ」、「キャンセル」ボタンの設置と処理分岐
  12. 要素(カテゴリ、ファミリ、タイプ)とは
  13. ElementIdとUniqueIdの違い
  14. 要素フィルターの使い方
  15. 要素のパラメータ一覧の取得
  16. pyRevitの導入と簡単なアプリケーションの作成
  17. Revit SDKのサンプルの場所とビルド方法
  18. FamilySymbol(タイプ)の取得とパラメータの変更
  19. 相対パスでdllにアイコン画像を埋め込む方法
  20. 「グループ」について
2026-10-03 21:48:52 atom 2622

人気ページ

最近更新/作成されたページ