定義ファイル

定義ファイル

DefinitionFile オブジェクトは共有パラメータ ファイルを表します。定義ファイルは一般的なテキスト ファイルです。定義ファイルは直接編集しないでください。編集する場合は UI または API を使用します。

定義ファイルの形式

共有パラメータ定義ファイルはテキスト ファイル(.txt)であり、META、GROUP、PARAM の 3 つのブロックで構成されます。GROUP と PARAM ブロックは、Revit API の共有パラメータ機能に関連します。

このファイルの読み込みおよび書き出しは Revit API が行いますが、次のセクションには、ファイルの形式に関する情報が記載されています。これらの情報は、共有パラメータのアクセスに使用される API オブジェクトとメソッドに対応しています。ファイルでは、フィールドを区別するのにタブを使用しており、テキスト エディタでは判読が難しい場合があります。下のコード領域は、サンプルの共有パラメータ テキスト ファイルの内容を表示します。

コード領域 22-1: パラメータ定義ファイルの例

# This is a Revit shared parameter file. # Do not edit manually. *META VERSION MINVERSION META 2 1 *GROUP ID NAME GROUP 1 MyGroup GROUP 2 AnotherGroup *PARAM GUID NAME DATATYPE DATACATEGORY GROUP VISIBLE DESCRIPTION USERMODIFIABLE PARAM bb7f0005-9692-4b76-8fa3-30cec8aecf74 Price INTEGER 2 1 Enter price in USD 1 PARAM b7ea2654-b206-4694-a087-756359b52e7f areaTags FAMILYTYPE -2005020 1 1 1 PARAM d1a5439d-dc8d-4053-99fa-2f33804bae0e MyParam TEXT 1 1 1

• GROUP ブロックにはグループ エントリがあり、各パラメータ定義をグループに関連付けます。GROUP ブロックには次のフィールドが表示されます。
  • ID - グループを一意に識別し、パラメータ定義をグループに関連付けます。
  • Name - UI に表示されるグループ名です。

• PARAM ブロックにはパラメータ定義が含まれます。PARAM ブロックには次のフィールドが表示されます。
  • GUID - パラメータ定義を識別します。
  • NAME - パラメータ定義名。
  • DATATYPE - パラメータ タイプ。このフィールドには共通のタイプ(TEXT、INTEGER など)や構造タイプ(FORCE、MOMENT など)、共通のファミリ タイプ(エリア タグなど)を使用できます。共通のタイプと構造タイプ パラメータはテキスト ファイルに直接指定されます(TEXT、FORCE など)。DATATYPE フィールドの値が FAMILYTYPE の場合、追加番号が付与されます。たとえば、FAMILYTYPE の後に -2005020 がある場合は、ファミリ タイプ「エリア タグ」を表します。
  • DATACATEGORY - DATATYPE が FAMILYTYPE となっているパラメータの、オプションのフィールドです。
  • GROUP - 現在のパラメータ定義を含むグループを識別するために使用されるグループ ID です。
  • VISIBLE - パラメータを表示するかどうかを指定します。このフィールド値は 0 か 1 です。

    0 = 非表示

    1 = 表示

  • DESCRIPTION - このパラメータのツールチップのオプションのフィールドです。
  • USERMODIFIABLE - ユーザがパラメータを編集できるかどうかを指定します。

    0 = ユーザはパラメータを編集できず、UI は淡色表示になる

    1 = ユーザは UI でパラメータ値を編集できる

サンプルの定義ファイルには、2 つのグループがあります。

• MyGroup - ID 1 - MyParam のパラメータ定義を含みます。これは、Text タイプのパラメータであり、FamilyType パラメータである areaTags の定義です。
• AnotherGroup - ID 2 - Price のパラメータ定義が含まれます。これは、整数タイプのパラメータです。

サンプル ファイルの 3 つのパラメータのうち、説明を持つのは Price のみです。すべてのパラメータは表示可能であり、ユーザによる修正が可能です。