定義ファイルアクセス

定義ファイルのアクセス

定義ファイルにアクセスするには、アドインのコードで次の手順を実行します。

既存または新しいテキストファイルを使用して Autodesk.Revit.Options.Application.SharedParametersFilename プロパティを指定します。
Application.OpenSharedParameterFile()メソッドを使用して、共有パラメータファイルを開きます。
DefinitionFile.Groups プロパティを使用して、既存のグループを開くか、新しいグループを作成します。
DefinitionGroup.Definitions プロパティを使用して、既存の外部パラメータ定義を開くか、新しい定義を作成します。

次のリストには、前の図のクラスとメソッドについての詳細情報が記載されています。

Autodesk.Revit.Parameters.DefinitionFile クラス - DefinitionFile オブジェクトは 1 つの共有パラメータファイルを表します。
- オブジェクトには多数の Group オブジェクトが含まれます。
- 共有パラメータは管理しやすいようにグループ化され、共有パラメータ定義を持ちます。
- 必要に応じて新しい定義を追加することができます。
- DefinitionFile オブジェクトは Application.OpenSharedParameterFile メソッドを使用して取得します。
Autodesk.Revit.Parameters.ExternalDefinition クラス - ExternalDefinition クラスは Definition クラスの派生クラスです。
- ExternalDefinition オブジェクトは共有パラメータファイルの DefinitionGroup オブジェクトで作成されます。
- 外部パラメータ定義は、共有パラメータ定義のコレクションとなっているグループに属している必要があります。
Autodesk.Revit.Options.Application.SharedParametersFilename プロパティ - Autodesk.Revit.Options.SharedParametersFilename プロパティを使用して、共有パラメータファイルのパスを取得、設定します。
- 既定では、Revit には共有パラメータファイルはありません。
- 使用する前にこのプロパティを初期化します。初期化していない場合は、例外が発生します。
Autodesk.Revit.Application.OpenSharedParameterFile メソッド - このメソッドは、Revit 共有パラメータファイルを表すオブジェクトを返します。
- Revit は、一度に 1 つの共有パラメータファイルを使用します。
- 共有パラメータファイルのファイル名は、Revit アプリケーションオプションオブジェクトに設定されます。ファイルが存在しない場合、例外が発生します。

共有パラメータファイルを作成する

共有パラメータファイルはテキストファイルであるため、コードを使用して作成したり、手動で作成することができます。

コード領域 22-3: 共有パラメータファイルを作成

private void CreateExternalSharedParamFile(string sharedParameterFile)
{
        System.IO.FileStream fileStream = System.IO.File.Create(sharedParameterFile);
        fileStream.Close();
}

既存の共有パラメータファイルにアクセスする

Revit では多くの共有パラメータファイルを作成できるため、アクセスしたいファイルや外部パラメータを明確に識別する必要があります。次の 2 つの手順は、既存の共有パラメータファイルへのアクセス方法を示しています。

外部パラメータファイルから DefinitionFile を取得する

共有パラメータファイルのパスを、次のコードにあるように app.Options.SharedParametersFilename に設定し、Autodesk.Revit.Application.OpenSharedParameterFile メソッドを呼び出します。

コード領域 22-4: 外部パラメータファイルから定義ファイルを取得

private DefinitionFile SetAndOpenExternalSharedParamFile(
        Autodesk.Revit.ApplicationServices.Application application, string sharedParameterFile)
{
        // set the path of shared parameter file to current Revit
        application.Options.SharedParametersFilename = sharedParameterFile;
        // open the file
        return application.OpenSharedParameterFile();
}

注: 共有パラメータのパスを設定するときは、次の点に注意してください。

それぞれのインストール時に、Revit の他のバージョンに共有パラメータファイルが設定されているかどうかを Revit は検出できません。新しく Revit をインストールする場合は、共有パラメータファイルを再度バインドする必要があります。
Options.SharedParametersFilename が間違ったパスに設定されている場合、OpenSharedParameterFile を呼び出したときにのみ例外が発生します。
Revit は複数の共有パラメータファイルを処理できます。パラメータのロード時に 1 つのパラメータファイルだけが使用されている場合でも、現在のファイルを自由に変更できます。

すべてのパラメータエントリを移動する

次の例は、パラメータエントリを移動し、その結果をメッセージボックスで表示する方法を示しています。

コード領域 22-5: パラメータエントリを移動

private void ShowDefinitionFileInfo(DefinitionFile myDefinitionFile)
{
        StringBuilder fileInformation = new StringBuilder(500);

        // get the file name 
        fileInformation.AppendLine("File Name: " + myDefinitionFile.Filename);

        // iterate the Definition groups of this file
        foreach (DefinitionGroup myGroup in myDefinitionFile.Groups)
        {
                // get the group name
                fileInformation.AppendLine("Group Name: " + myGroup.Name);

                // iterate the difinitions
                foreach (Definition definition in myGroup.Definitions)
                {
                        // get definition name
                        fileInformation.AppendLine("Definition Name: " + definition.Name);
                }
        }
        TaskDialog.Show("Revit", fileInformation.ToString());
}

パラメータ定義の所有者グループを変更する

次の例は、パラメータ定義グループの所有者を変更する方法を示します。

コード領域 22-6: パラメータ定義グループの所有者を変更

private void ReadEditExternalParam(DefinitionFile file)
{
        // get ExternalDefinition from shared parameter file
        DefinitionGroups myGroups = file.Groups;
        DefinitionGroup myGroup = myGroups.get_Item("MyGroup");
        if (null == myGroup)
                return;
 
        Definitions myDefinitions = myGroup.Definitions;
        ExternalDefinition myExtDef =
                                                        myDefinitions.get_Item("MyParam") as ExternalDefinition;
        if (null == myExtDef)
                return;

        StringBuilder strBuilder = new StringBuilder();
        // iterate every property of the ExternalDefinition
        strBuilder.AppendLine("GUID: " + myExtDef.GUID.ToString())
                .AppendLine("Name: " + myExtDef.Name)
                .AppendLine("OwnerGroup: " + myExtDef.OwnerGroup.Name)
                .AppendLine("Parameter Group" + myExtDef.ParameterGroup.ToString())
                .AppendLine("Parameter Type" + myExtDef.ParameterType.ToString())
                .AppendLine("Is Visible: " + myExtDef.Visible.ToString());

        TaskDialog.Show("Revit", strBuilder.ToString());

        // change the OwnerGroup of the ExternalDefinition
        myExtDef.OwnerGroup = myGroups.get_Item("AnotherGroup");
}

定義ファイル アクセス

定義ファイルのアクセス

共有パラメータ ファイルを作成する

既存の共有パラメータ ファイルにアクセスする