Document 機能

Document 機能

ドキュメントは Revit 要素を格納し、データを管理し、複数のデータ ビューを更新します。Document クラスは、主に次の関数を提供します。

ドキュメント

Document クラスはオープンされている Autodesk Revit プロジェクトを表します。

設定プロパティ

設定プロパティは、Revit プロジェクト内の一般的なコンポーネントへのアクセスを提供するオブジェクトを返します。詳細は、「設定」を参照してください。

位置と場所

各プロジェクトには、プロジェクトの地球上での物理的な場所を特定する唯一のサイトがあります。1 つのプロジェクトに複数のプロジェクトの場所を指定できます。各場所は、そのサイトのオフセットまたは回転です。詳細は、「位置と場所」を参照してください。

ビュー管理

プロジェクト ドキュメントは複数のビューを持つことができます。ActiveView プロパティは、アクティブなビューを表すビュー オブジェクトを返します。他のビューを取得するには、プロジェクトの要素をフィルタします。詳細は、「ビュー」を参照してください。

要素の取得

ドキュメント オブジェクトはプロジェクト内に要素を保存します。要素プロパティを使用して ElementId や UniqueId により特定の要素を取得します。

詳細は、「要素の基本」を参照してください。

ファイル管理

各ドキュメント オブジェクトは Revit プロジェクト ファイルを表します。ドキュメントには次の機能があります。

• ファイル パス名やプロジェクト タイトルなどのファイル情報を取得します。
• ドキュメントを閉じるための Close()メソッド、保存するための Save()メソッドがあります。

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

要素の管理

Revit はすべての要素オブジェクトをプロジェクト内に保持します。新しい要素を作成するには、Revit プラットフォーム API に新しいプロジェクト要素インスタンス(FamilyInstance や Group など)を作成するのに使用される Object Factory を返す作成プロパティを使用します。

Document クラスを使用すると要素を削除することもできます。プロジェクト内の要素を削除するには、Delete()メソッドを使用します。削除された要素とすべての従属要素は表示されず、ドキュメントから削除されます。削除された要素への参照は無効になり、例外が発生します。詳細は、「要素を編集する」を参照してください。

イベント

イベントは、[保存]や[名前を付けて保存]を使用してプロジェクトを保存する場合などの特定のアクションの実行時に発生します。アプリケーションでイベントや応答をキャプチャするには、イベント ハンドラを登録する必要があります。詳細は、「イベント」を参照してください。

ドキュメント ステータス

いくつかのプロパティは、ドキュメントのステータスに関する次のような情報を提供します。

• IsModifiable - ドキュメントが現在修正中かどうかを表します(ドキュメントにアクティブなトランザクションがあり、他の理由で変更が一時的にブロックされているのではないことを示します)
• IsModified - ドキュメントを開いて以降、または保存して以降にドキュメントを変更したかどうか
• IsReadOnly - true の場合、ドキュメントは現在読み込み専用になっており、修正できません
• IsReadOnlyFile - ドキュメントが読み取り専用モードで開かれているかどうか
• IsFamilyDocument - ドキュメントがファミリ ドキュメントかどうか
• IsWorkshared - ワークセットがドキュメントで有効になっているかどうか

その他

それ以外にもドキュメントには次のような関数があります。

• ParameterBindings プロパティ - パラメータ定義とカテゴリの間のマッピングです。詳細は、「共有パラメータ」を参照してください。
• ReactionsAreUpToDate プロパティ - 反動負荷が変更されたかどうかを報告します。詳細は、「Revit Structure」セクションの「荷重」を参照してください。
• Default Types - ファミリと非ファミリ要素の既定のタイプにアクセスします。詳細については、「既定のタイプ」を参照してください。

UIDocument

UIDocument クラスは、Revit ユーザ インタフェースで開かれた Autodesk Revit プロジェクトを表します。

要素の取得

UIDocument で選択プロパティを使用して選択した要素を取得します。このプロパティは、選択したプロジェクト要素を含むアクティブな選択を表現するオブジェクトを返します。また、Revit モデル内のオブジェクトを選択するための UI 操作メソッドを提供します。

詳細は、「要素の基本」を参照してください。

要素の表示

ShowElements()メソッドは全体表示を使用してもう 1 つの要素にフォーカスします。

ビュー管理

UIDocument クラスを使用すると、RefreshActiveView()メソッドを呼び出してアクティブなドキュメントのアクティブなビューを更新できます。ActiveView プロパティを使用すると、ドキュメントのアクティブなビューを取得したり設定したりできます。アクティブなビューの変更にはいくつかの制限事項があります。これはアクティブなドキュメントのみで使用され、読み取り専用状態のときや、トランザクションの中では実行できません。また、アクティブなビューは ViewActivating や ViewActivated イベント中、また DocumentSaving、DocumentClosing や他の同様のイベントなどの予作動イベント中には変更できません。

UIDocument.ActiveGraphicalView プロパティは、ドキュメントのアクティブなビューを取得します。UIDocument.ActiveView とは異なり、ユーザがいずれかのビューを選択した場合でも、プロジェクト ブラウザやシステム ブラウザのように、このプロパティが補助ビューを返すことはありません。

さらに、UIDocument を使用すると、Revit ユーザ インタフェースで開いているすべてのビュー ウィンドウのリストを取得することができます。GetOpenUIViews メソッドは、Revit ユーザ インタフェースのビュー ウィンドウに関するデータを含む UIViews のリストを返します。