定義ファイル

定義ファイル

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

定義ファイルの形式

共有パラメータ定義ファイルはテキスト ファイル(.txt)であり、GROUP と PARAM の 2 つのブロックで構成されます。

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

# This is a Revit shared parameter file.
# Do not edit manually.
*GROUP  ID      NAME
GROUP   1       MyGroup 
GROUP   2       AnotherGroup 
*PARAM GUID     NAME    DATATYPE        DATACATEGORY    GROUP   VISIBLE 
PARAM   4b217a6d-87d0-4e64-9bbc-42b69d37dda6    MyParam TEXT    1 1
PARAM   34b5cb95-a526-4406-806d-dae3e8c66fa9    Price   INTEGER 2 1 
PARAM   05569bb2-9488-4be4-ae21-b065f93f7dd6    areaTags        FAMILYTYPE -2005020 1 1
  • GROUP ブロックにはグループ エントリがあり、各パラメータ定義をグループに関連付けます。GROUP ブロックには次のフィールドが表示されます。
    • ID - グループを一意に識別し、パラメータ定義をグループに関連付けます。
    • Name - UI に表示されるグループ名です。

      図 130: 共有パラメータを編集(グループとパラメータ)

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

      コード領域 22-2: 共有パラメータ FAMILYTYPE の例

      FAMILYTYPE -2005020

      図 131: 新しいパラメータ定義

    • GROUP - 現在のパラメータ定義を含むグループを識別するために使用されるグループ ID です。
    • VISIBLE - パラメータを表示するかどうかを指定します。このフィールド値は 0 か 1 です。

      0 = 非表示

      1 = 表示

定義ファイルの例にも表示されているように、次の 2 つのグループがあります。

  • MyGroup - ID 1 - MyParam のパラメータ定義が含まれます。これは、テキスト タイプのパラメータです。
  • AnotherGroup - ID 2 - Price のパラメータ定義が含まれます。これは、整数タイプのパラメータです。