Application 機能

Application と UIApplication メンバーはアプリケーション全体のデータと設定、さらに Revit のアクティブ セッションへのアクセスを提供します。

アプリケーション

クラスは Autodesk Revit アプリケーションを表し、ドキュメント、オプション、他のアプリケーション全体のデータと設定へのアクセスを提供します。

アプリケーションのバージョン情報

アプリケーション プロパティには、VersionBuild、VersionNumber、VersionName があります。これらを使用すると、「アドインの正しいバージョンを強制するためのアプリケーション プロパティの使用方法」にあるように、Revit のリリースとビルドに基づいたアドインの動作を提供できます。

アプリケーション全体の設定

共有パラメータ

Revit は、一度に 1 つの共有パラメータ ファイルを使用します。Application.OpenSharedParameterFile()メソッドは、パスが SharedParametersFilename プロパティに設定されている共有パラメータ ファイルにアクセスします。詳細は、「共有パラメータ」を参照してください。

ライブラリ コンテンツ

GetLibraryPaths()と SetLibraryPaths()メソッドは、Revit がコンテンツを検索する場所を特定するパス情報へのアクセスを提供します。

グラフィック表示

BackgroundColor プロパティを使用すると、このセッションのモデル ビューに使用する背景色の読み取りと書き込みが可能になります。AllowNavigationDuringRedraw プロパティでは、再描画中のビュー操作を許可するオプションを有効または無効にできます。これを使用すると、モデルを再描画中のパフォーマンスを最適化できます。

ドキュメント管理

アプリケーション クラスには、次のタイプのドキュメントを作成するためのメソッドがあります。

  • ファミリ ドキュメント
  • プロジェクト ドキュメント
  • プロジェクト テンプレート

OpenDocumentFile()メソッドを使用すると、これらのドキュメント タイプを開くことができます。

開いているドキュメントはすべてドキュメント プロパティを使用して取得できます。

詳細は、「ドキュメントと管理」を参照してください。

セッション情報

UserName などのプロパティや GetRevitServerNetworkHosts()メソッドなどを使用すると、このセッション固有情報への読み込み専用アクセスが可能になります。

ログイン情報

静的 IsLoggedIn プロパティは、ユーザがこのセッションから Autodesk A360 アカウントにログインしているかどうかを確認します。ログインしている場合は、LoginUserId プロパティによって現在ログインしているユーザの ID が返されます。(ユーザがログインしていない場合は、ユーザ ID が空になります)。上記のセクションの UserName と異なり、LoginUserId の値は認識可能な値ではなく、内部 ID となります。Store Entitlement REST API と連動させると、Autodesk Exchange Store アプリのパブリッシャーは、現在のユーザがストアからパブリッシャーのアプリを購入したかどうかを確認できます。Store Entitlement API の詳細については、http://www.autodesk.com/developapps を参照してください。

共有パラメータ管理

イベント

アプリケーション クラスは、ドキュメントを開く、保存するなどの、ドキュメントとアプリケーションのイベントを表示します。これらのイベントに登録すると、イベントが有効になった時間がアプリケーションに通知され、それに応じて動作します。詳細は、「アドインの統合」セクションの「Revit イベントへのアクセス」を参照してください。

作成

Create プロパティは、Revit プラットフォーム API でアプリケーション全体のユーティリティとジオメトリック オブジェクトを作成するために使用する Object Factory を返します。アプリケーションのメモリではなく、Revit アプリケーション メモリにオブジェクトを作成する場合に Create を使用します。

ポストおよび処理エラー

登録されているすべての FailureDefinition を含む FailureDefinitionRegistry は、静的 GetFailureDefinitionRegistry()メソッドから使用できます。静的メソッド RegisterFailuresProcessor() を使用すると、カスタムの IFailuresProcessor を登録できます。エラーのポスト、処理の詳細については、「エラーを投稿、処理する」を参照してください。

切断の警告

次のプロパティでは、さまざまなタイプの切断に関するグラフィックスによる警告を表示するかどうかをコントロールします。

  • ShowGraphicalWarningCableTrayConduitDisconnects
  • ShowGraphicalWarningDuctDisconnects
  • ShowGraphicalWarningElectricalDisconnects
  • ShowGraphicalWarningHangerDisconnects
  • ShowGraphicalWarningPipeDisconnects

UIApplication

このクラスは、Autodesk Revit ユーザ インタフェースのアクティブなセッションを表し、UI カスタマイズ メソッド、イベント、アクティブなドキュメントへのアクセスを提供します。

ドキュメント管理

UIApplication は、UIActiveDocument プロパティを使用して、アクティブなドキュメントへのアクセスを提供します。さらに、Revit ドキュメントは、オーバーロードした OpenAndActivateDocument()メソッドを使用して開くことができます。ドキュメントが開き、既定のビューがアクティブとなります。Revit でアクティブなドキュメントが開いておらず、別のイベントにイベントがネストされていない場合、トランザクション内でこのメソッドを呼び出せず、イベント中にのみ呼び出すことができる場合があります。

アドインの管理

ActiveAddInId プロパティは現在アクティブな外部アプリケーションや外部コマンド ID を取得し、LoadedApplications プロパティは正常にロードされた外部アプリケーションの配列を返します。

リボン パネルのユーティリティ

新しいリボン パネルとコントロールを Revit に追加するには、UIApplication オブジェクトを使用します。

詳細は、「アドインの統合」セクションの「リボン パネルとコントロール」を参照してください。

範囲

DrawingAreaExtents プロパティは作図領域の画面ピクセル座標を表す四角形を返し、MainWindowExtents プロパティは Revit メイン ウィンドウの画面ピクセル座標を表す四角形を返します。

イベント

UIApplication クラスは、ダイアログ ボックスを表示した時間などの、UI 関連のイベントを表示します。これらのイベントに登録すると、イベントが有効になった時間がアプリケーションに通知され、それに応じて動作します。詳細は、「アドインの統合」セクションの「Revit イベントへのアクセス」を参照してください。