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

▶

ページの作成

親となるページを選択してください。

ページは必ず何かしらの親ページに紐づきます。
親ページに紐づくページを子ページといいます。
例：親=スポーツ, 子1=サッカー, 子2=野球

子ページを親ページとして更に子ページを作成することも可能です。
例：親=サッカー, 子=サッカーのルール

親ページはいつでも変更することが可能なのでとりあえず作ってみましょう！

テンプレート

前提

Visual Studioをインストール済み

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

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

プロジェクトの作成

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

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

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

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

Class1.cs
using System; namespace CsSampleProject { public class Class1 { } }

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

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

DLLの参照

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

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

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

実装

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

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; } } }

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メソッドを実装する。これはボタンを押された際の処理を定義する。

ビルド

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

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

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

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

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

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

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>

CsSampleProject.addin

<Name>SampleAddin</Name>

<Assembly>CsSampleProject.dll</Assembly>

<FullClassName>CsSampleProject.CsHelloWorld</FullClassName>

</AddIn>

</RevitAddIns>

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

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

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