ウォークスルー: Hello World

示された手順を使用して Hello World プログラムを作成するには、Revit プラットフォーム API および C# を使用します。VB.NET を使用したアドインアプリケーションの作成方法については、「VB.NET の Hello World」を参照してください。

Hello World ウォークスルーは、次のトピックを取り扱います。

新しいプロジェクトを作成します。
参照を追加します。
クラス名を変更します。
コードを記述します。
アドインをデバッグします。

このセクションのすべての操作およびコードは、Visual Studio 2012 を使用して作成されました。

新しいプロジェクトを作成する

Visual Studio で C# プログラムを作成するには、まずプロジェクトタイプを選択し、新しいクラスライブラリを作成します。

[ファイル] メニューから、[新規作成] [プロジェクト]を選択します。
[インストールされたテンプレート]フレームで、[Visual C#]をクリックします。
右側のフレームで、[クラスライブラリ](図 1: 下の[新規プロジェクトの追加]を参照)をクリックします。このウォークスルーは、プロジェクトの場所が D:¥Sample であることを前提としています。
[名前]フィールドに、プロジェクトの名前として「HelloWorld」と入力します。
[OK]をクリックします。

図 1: 新規プロジェクトを追加

参照の追加

RevitAPI 参照を追加するには:
- [ソリューションエクスプローラ]ウィンドウが開いていない場合は、[表示]メニューから[ソリューションエクスプローラ]を選択します。
- [ソリューションエクスプローラ]で、[参照]を右クリックして[コンテキスト]メニューを表示します。
- [コンテキスト]メニューから、[参照の追加]をクリックします。[参照の追加]ダイアログボックスが表示されます。
- [参照の追加]ダイアログボックスで、[参照]タブをクリックします。Revit がインストールされているフォルダを指定し、RevitAPI.dll をクリックします。たとえば、インストールされているフォルダの場所は、通常は C:¥Program Files¥Autodesk¥Revit 2016¥RevitAPI.dll です。
- [OK]をクリックして .dll を選択して、ダイアログボックスを閉じます。RevitAPI が[ソリューションエクスプローラ]の参照ツリーに表示されます。
- 注: 新しいプロジェクトの場合は、RevitAPI.dll の[ローカルコピー]プロパティを常時 false に設定する必要があります。これでディスク容量を節約でき、Visual Studio デバッガが DLL のコピーを使用して不整合が発生することを防ぎます。RevitAPI.dll を右クリックし、[プロパティ]を選択し、[ローカルコピー]設定を true (既定)から false に変更します。
RevitAPIUI.dll に対して上記の手順を繰り返します。

コードを追加

アドインを作成するには、次のコードを追加します。

コード領域 2-1: スタートアップ

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

namespace HelloWorld
{
   [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;
      }
   }
}

ヒント: Visual Studio IntelliSense 機能を使用して、インタフェースのスケルトン実装を作成できます。これによりスタブをすべての必要なメソッドに追加します。上記の例では Class1 の後に「:IExternalCommand」を追加後、Intellisense メニューから「Implement IExternalCommand」を選択してコードを取得できます。

図 2: Intellisense を使用してインタフェースを実装

すべての Revit アドインアプリケーションには、IExternalCommand インタフェースを実装するエントリポイントクラスが必要です。また、Execute()メソッドを実装する必要があります。Execute()メソッドは、他のプログラムの Main()メソッドに似たアドインアプリケーションのエントリポイントです。アドインエントリポイントクラス定義がアセンブリに含まれています。詳細は、「アドインの統合」を参照してください。

プログラムをビルドする

コードを作成した後、ファイルをビルドする必要があります。[ビルド]メニューから、[ソリューションのビルド]をクリックします。ビルドの出力が出力ウィンドウに表示され、エラーなしでプロジェクトがコンパイルされたことを表します。

.addin マニフェストファイルを作成する

HelloWorld.dll プロジェクトの出力ディレクトリに表示されます。Revit でアプリケーションを呼び出す場合は、Revit に登録するマニフェストファイルを作成します。

マニフェストファイルを作成するには、メモ帳で新しいテキストファイルを作成します。

次の文字を追加します。


コード領域 2-2: 外部コマンドの .addin マニフェストファイルを作成
<?xml version="1.0" encoding="utf-8" standalone="no"?> <RevitAddIns> <AddIn Type="Command"> <Assembly>D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll</Assembly> <AddInId>239BD853-36E4-461f-9171-C5ACEDA4E721</AddInId> <FullClassName>HelloWorld.Class1</FullClassName> <Text>HelloWorld</Text> <VendorId>NAME</VendorId> <VendorDescription>Your Company Information</VendorDescription> </AddIn> </RevitAddIns>

コード領域 2-2: 外部コマンドの .addin マニフェストファイルを作成

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<RevitAddIns>
        <AddIn Type="Command">
                <Assembly>D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll</Assembly>
                <AddInId>239BD853-36E4-461f-9171-C5ACEDA4E721</AddInId>
                <FullClassName>HelloWorld.Class1</FullClassName>
                <Text>HelloWorld</Text> 
                <VendorId>NAME</VendorId>
                <VendorDescription>Your Company Information</VendorDescription> 
        </AddIn>
</RevitAddIns>

HelloWorld.addin という名前でファイルを保存して、次の場所に置きます。
- C:¥ProgramData¥Autodesk¥Revit¥Addins¥2016¥
- アプリケーションのアセンブリ dll が、ネットワーク共有にあって、ローカルハードドライブにない場合、ローカルコンピュータ以外の .NET アセンブリのロードを許可するには、Revit.exe.config を修正する必要があります。Revit.exe.config の「runtime」ノードに、下の図のように要素 <loadFromRemoteSources enabled="true"/> " を追加します。
```
<runtime>
        <generatePublisherEvidence enabled="false" />
        <loadFromRemoteSources enabled="true"/> 
</runtime>
```

マニフェストファイルの使用の詳細は、「アドインの統合」を参照してください。

アドインをデバッグする

デバッグモードでプログラムを実行する場合、変数やオブジェクトの状態を調べるためにプログラムを一時停止するには、ブレークポイントを使用します。エラーがある場合は、プログラムを実行して変数を確認することで、予期しない値が発生する原因を推定することができます。

[ソリューションエクスプローラ] ウィンドウで、HelloWorld プロジェクトを右クリックすると、コンテキストメニューが表示されます。
[コンテキスト]メニューから、[プロパティ]をクリックします。[プロパティ]ウィンドウが表示されます。
[デバッグ]タブをクリックします。
[アクションを開始]セクションで、[外部プログラムを開始]をクリックし、Revit.exe ファイルを参照します。既定では、ファイルは次のパス: C:¥Program Files¥Autodesk¥Revit 2016¥Revit.exe に格納されます。

図 3: デバッグ環境を設定
[デバッグ]メニューから、[ブレークポイントを切り替え]を選択し(または [F9]を押す)、次の行にブレークポイントを設定します。
```
TaskDialog.Show("Revit", "Hello World");
```
デバッグ手順を開始するには、[F5] を押します。

テストデバッグ:

[アドイン]タブで、[外部ツール]メニューボタンに HelloWorld が表示されます。

図 4: HelloWorld 外部ツールコマンド
[HelloWorld]をクリックするとプログラムが実行され、ブレークポイントが有効になります。
プログラムの実行を続行するには、[F5] を押します。次のシステムメッセージが表示されます。

図 5: TaskDialog メッセージ

トラブルシューティング

Q: 自分のアドインアプリケーションがコンパイルできません。

A: サンプルコードをコンパイルするとエラーが表示される場合は、アドインのコンパイルに使用された RevitAPI のバージョンが問題である場合があります。古い RevitAPI 参照を削除して、新しい RevitAPI 参照をロードします。詳細は、「参照の追加」を参照してください。

Q: [アドイン]タブがない、または自分のアドインアプリケーションが[外部ツール]の下に表示されないのはなぜですか?

A: 多くの場合、アドインアプリケーションのロードに失敗すると、Revit はエラーについての情報に関するエラーダイアログを起動時に表示します。たとえば、マニフェストファイルの指定した場所にアドイン DLL が見つからない場合は、次のようなメッセージが表示されます。

図 6: 外部ツールエラーメッセージ

FullClassName で指定されたクラス名が見つからない、または IExternalCommand から継承されない場合も、エラーメッセージが表示されます。

ただし、場合によっては、アドインアプリケーションがメッセージなしでロードに失敗する場合があります。考えられる原因には、次が含まれます。

アドインアプリケーションが、異なる RevitAPI バージョンでコンパイルされている
マニフェストファイルが見つからない
.addin マニフェストファイルのフォーマットエラー

Q: 自分のアドインアプリケーションが動作しないのはなぜですか?

A: アドインアプリケーションが外部ツールの下にある場合でも、動作しない場合があります。多くの場合、コードの例外が原因です。

Revit では、コマンドが失敗したとき、例外についての情報を含むエラーダイアログが表示されます。

図 7: 外部コマンドで処理できない例外

これはコマンドのデバッグの支援を目的としています。ユーザに展開されるコマンドは、例のエントリメソッドで try..catch..finally を使用し、Revit によって例外が捕捉されるのを防ぐ必要があります。次に例を示します。

コード領域 2-4: 実行文で Try Catch を使用:

public IExternalCommand.Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
        ExternalCommandData cdata = commandData;
        Autodesk.Revit.ApplicationServices.Application app = cdata.Application;

        try
        {
                // Your code here
        }
        
        catch (Exception ex)
        {
                message = ex.Message;
                return Autodesk.Revit.UI.Result.Failed;
        }
                return Autodesk.Revit.UI.Result.Succeeded;   
}

ウォークスルー: Hello World