BuiltInParameter

BuiltInParameter

Revit プラットフォーム API には多数の組み込みパラメータがあり、Autodesk.Revit.Parameters.BuiltInParameter 列挙に定義されています(この列挙の定義については RevitAPI Help.chm ファイルを参照)。下に示すように、この列挙により Visual Studio IntelliSense で閲覧可能なドキュメントが生成されます。各 ID のドキュメントには、英語バージョンのAutodesk Revit の[要素プロパティ]ダイアログに表示されるパラメータ名が含まれます。複数の特定のパラメータ ID は同名の英語名にマップできる場合があります。そのような場合、使用するパラメータ ID を判断するには、特定の要素に関連付けられたパラメータを調べる必要があります。

要素から特定のパラメータを取得するにはパラメータ ID を使用しますが、もしあれば、Element.Parameter プロパティを使用します。ただし、ID を使用してもすべてのパラメータが取得できるわけではありません。たとえば、ファミリ パラメータは Revit プラットフォーム API に表示されないので、組み込みパラメータ ID を使用してそれらを取得することはできません。

次のコード サンプルは、BuiltInParameter ID を使用して特定のパラメータを取得する方法を説明しています。

コード領域 8-3: BuiltInParameter に基づいてパラメータを取得

public Parameter FindWithBuiltinParameterID(Wall wall)
{
        // Use the WALL_BASE_OFFSET paramametId
        // to get the base offset parameter of the wall.
        BuiltInParameter paraIndex = BuiltInParameter.WALL_BASE_OFFSET;
        Parameter parameter = wall.get_Parameter(paraIndex);
        
        return parameter;
}
注: パラメータ オーバーロードを使用すると、メソッド パラメータとして列挙タイプ BuiltInParameter を使用できます。たとえば、BuiltInParameter.GENERIC_WIDTH を使用します。

正確な BuiltInParameter ID が分からない場合は、ParameterSet コレクションを繰り返してパラメータを取得します。テストや特定を目的とする場合は、get_Parameter()メソッドを使用して各 BuiltInParameter をテストするという方法もあります。この方法を使用する場合、ParameterSet コレクションに get_Parameter()メソッドから返されるすべてのパラメータが含まれない場合がありますが、このようなケースはまれです。