◀ 5.

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

▶
編集

この記事の要点

  • Revit のアドイン（外部アプリケーション）を C# + Visual Studio で作成するサンプル
  • プロジェクト: クラスライブラリ (.NET Framework) を選択
  • 実装: IExternalApplication を実装し、OnStartup で UI 追加
  • .addin マニフェストファイルで Revit に登録、デバッグは Revit を起動して使う

 

1前提

Visual Studioをインストール済み

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

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

 

2プロジェクトの作成

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

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

プロジェクトの作成の図

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

 

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

Class1.cs
using System;

namespace CsSampleProject
{
    public class Class1
    {
    }
}
 

 

※入力フォームなどの画面UIを作成する場合は「.NET Framework」を使用すること

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

プロジェクトの作成の図

 

3DLLの参照

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

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

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

 

4実装

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

Class1.cs

using System;
using System.Reflection;

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

namespace CsSampleProject
{
    [Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]

    public class CsHelloWorld : IExternalApplication
    {
        public Result OnStartup(UIControlledApplication application)
        {
            RibbonPanel ribbonPanel = application.CreateRibbonPanel("NewRibbonPanel");

            string thisAssemblyPath = Assembly.GetExecutingAssembly().Location;
            PushButtonData buttonData = new PushButtonData("cmdHelloWorld",
               "Hello World", thisAssemblyPath, "CsSampleProject.HelloWorld");

            PushButton pushButton = ribbonPanel.AddItem(buttonData) as PushButton;

            pushButton.ToolTip = "Say hello to the entire world.";

            return Result.Succeeded;
        }

        public Result OnShutdown(UIControlledApplication application)
        {
            return Result.Succeeded;
        }
    }

    [Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
    public class HelloWorld : 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;
        }
    }

}

IExternalApplicationを継承したクラスはOnStartupとOnShutdownメソッドを実装する。それぞれRevitの起動時と終了時に呼び出される処理を定義する。

IExternalCommandを継承クラスはExecuteメソッドを実装する。これはボタンを押された際の処理を定義する。

 

5ビルド

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

ビルドの図

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

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

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

 

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

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

CsSampleProject.addin

<RevitAddIns>

    <AddIn Type="Application">

        <Name>SampleAddin</Name>

        <Assembly>CsSampleProject.dll</Assembly>

        <FullClassName>CsSampleProject.CsHelloWorld</FullClassName>

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

        <VendorId>会社名</VendorId>

        <VendorDescription>会社説明</VendorDescr
iption>

    </AddIn>

</RevitAddIns>

※Assemlyはddlの出力先を指定する。

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

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-09-07 03:02:39 T 2333

人気ページ

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